Skip to content

Repository files navigation

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();

About

The official Keyforge API client library for Javascript and Typescript.

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages