depro-sdk v0.0.2-beta

depro-sdk

DePro SDK allows developers to integrate DePro onto their web apps and start issuing and claiming credentials

Getting Started

Install the dePro sdk to your nodejs application.

npm install --save depro-sdk

Configure Depro SDK

Configure the Depro sdk using your key

import { DeproConfig, DEPRO } from "depro-sdk";

const deproConfig: DeproConfig = {
  key: "--------- Key -----------",
};

const depro: DEPRO = new DEPRO(deproConfig);

depro.initialize();

Creating a DePro Profile

DePro needs alias,password,type and email when registering. Here the user type will be PROFILE and CREDENTIALPROVIDER

const data = {
  alias: alias,
  password: password,
  type: UserType,
  email: email,
};

await DEPRO.auth.register(data);

Niftron Login

pass the secretKey of the user

const secretKey = "";

await DEPRO.auth.niftronLogin(secretKey);

Updating the the profile's details

The profileType will be RESUME or PRODUCT

const data = {
  files: files,
  county: string,
  phoneNumber: string,
  profileType: profileType,
  publicKey: string,
  token: string,
};

await DEPRO.profile.addProfileData(data);

Updating the the Credential Provider's details

const data = {
  files: files,
  county: string,
  phoneNumber: string,
  name: string,
  city: string,
  publicKey: string,
  token: string,
};

await DEPRO.credentialProvider.addCredentialProviderData(data);

Issuing Credentials

The receiverType will be RESUME or PRODUCT

const data = {
  email: string,
  secretKey: string,
  publicKey: string,
  blockchainValue: string,
  isClaimable: boolean,
  receiverType: receiverType,
  token: token,
  imageFile: imageFile,
  latestIpfsUrl: {
    ipfsUrl: string,
    timestamp: Date.now(),
  },
};

await DEPRO.credentialProvider.issueCredential(data);

Retrieving Credential

The uniqueId of the credential

await DEPRO.profile.retrieveCredential(uniqueId);

Claiming Credentials

const data = {
  secretKey:string,
  publicKey:string,
  senderPublicKey:string,
  blockchainValue:string,
  token:string,
  latestIpfsUrl:string
  itemName:string,
  description:string
  uniqueId:string,

}

await DEPRO.profile.claimCredential(data);

Log out

const data = {
  secretKey:string,
  publicKey:string,
  senderPublicKey:string,
  blockchainValue:string,
  token:string,
  latestIpfsUrl:string
  itemName:string,
  description:string
  uniqueId:string,

}

await DEPRO.auth.niftronLogOut();