@keyforgecloud/lib
TypeScript icon, indicating that this package has built-in type declarations

1.4.0 • Public • Published

keyforge

npm package Build Status Downloads Issues Code Coverage Commitizen Friendly Semantic Release

The official Keyforge API client library for Javascript and Typescript.

Install

npm install @keyforgecloud/lib

Usage

import KeyforgeAPI from '@keyforgecloud/lib';

const createAndVerify = async () => {
  KeyforgeAPI.setAccountToken("your-account-token")
  KeyforgeAPI.setDefaultAPI("your-api-id")

  const key = await KeyforgeAPI.createKey({
    name: 'My Key',
    ownerId: 'user_abc123',
    permissions: ['read', 'write'],
    metadata: {
      "key": "value"
    }
  }, 'your-api-id'); // API ID is optional if set a default (KeyforgeAPI.setDefaultAPI)

  const verification = await KeyforgeAPI.verifyKey(key.token)
    .then(() => true)
    .catch(() => false);

  if (verification) {
    console.log('Key verified successfully');
  } else {
    console.log('Key verification failed');
  }
};

createAndVerify();

Dependencies (1)

Dev Dependencies (19)

Package Sidebar

Install

npm i @keyforgecloud/lib

Weekly Downloads

6

Version

1.4.0

License

MIT

Unpacked Size

15.7 kB

Total Files

27

Last publish

Collaborators

  • dawsson