wallid-certishop v1.1.3

CertiShop Lib

This is a Node.js library designed to interact with WalliD Certishop protocol for issuing and verifying digital certificates. It authenticates using an apiKeyToken and manages JWT tokens for authenticated requests. The library automatically retries authentication if the token expires.

Installation

To install the library in your Node.js project, run:

npm install wallid-certishop

Usage

1. Import the library

const { configure, createCredentials, verifyCredentials } = require('credential-management-lib');

2. Configure the library

Set your apiKeyToken for authentication:

init('your_api_key_token');

Create Credential Authority (CA)

const payload = {
    wa : "wallet_address", // wallet address of the CA
    admin_email : "admin_email" // admin email of the CA
}

createCA(payload)
  .then(response => console.log('CA Created:', response))
  .catch(error => console.error('Error creating CA:', error));

Create Template

const payload = {
  cid: 'cid_value', // Certificate Authority (CA) id
  name: 'template_name',
  waAdmin: 'waAdmin_value', // wallet address of the admin creating the template
  frontendProps: {
    components: [
      {
        id: 'component_id'
        ...
        type: 'text',
      }
    ],
    currentLayout: 'current_layout'
  }
}

createTemplate(payload)
  .then(response => console.log('Template Created:', response))
  .catch(error => console.error('Error creating template:', error));

Create certificates

const payload = {
  cid: 'cid_value', // Certificate Authority (CA) id
  tid: 'tid_value', // Template id 
  waAdmin: 'waAdmin_value', // wallet address of the admin creating the credential
  data: [{ key: 'value' }], // data to be stored in the credential (in the format of a list of key value pairs)
  email: 'user@domain.com', // email where the credential will be sent
};
createCredentials(payload)
  .then(response => console.log('Credentials Created:', response))
  .catch(error => console.error('Error creating credentials:', error));

Verify certificates

const payload = {
  tid: 'tid_value', // required to verify the any credential matching this tid
  id: 'id_value', // if sent will try to verify the credential with this id, if not sent will match any credential with this tid
  guid: 'guid_value', // this is a unique identifier for the verification session and is returned in the init method
};

verifyCredentials(payload)
  .then(response => console.log('Verification URL:', response))
  .catch(error => console.error('Error verifying credentials:', error));

Running Tests

1. Install dependencies:

   npm install

2. Run the tests:

   npm test

License

This project is licensed under the MIT License.