toknize

x-tkn

x-tkn is an API that provides Stateful Web Tokens.

An API Key is required and can be obtained at https://x-tkn.com by signing up for a free account.

Installation

npm install x-tkn --save

Setup

The x-tkn SDK needs your API Key in order to authenticate correctly. This can be done in one of two ways

Environment Variable

X_TKN_API_KEY_ID=YOUR_API_KEY

In Code

import {x-tkn} from 'x-tkn'

x-tkn({apiKeyId: YOUR_API_KEY})

Methods

createToken(data)

import {createToken} from 'x-tkn'

// ...

let data = {
    type: 'session',
    payload: {'hello': 'world'},
    uses: 0,
    maxUses: 1,
    expiresAt: new Date('2040-07-10 15:00:00.000')
}

let token = await createToken(data)

deleteToken(tokenId)

import {deleteToken} from 'x-tkn'

// ...

await deleteToken('some-token-id')

readToken(tokenId)

import {readToken} from 'x-tkn'

// ...

let token = await readToken('some-token-id')

redeemToken(tokenId)

import {redeemToken} from 'x-tkn'

// ...

let token = await redeemToken('some-token-id')

revokeToken(tokenId)

import {revokeToken} from 'x-tkn'

// ...

let token = await revokeToken('some-token-id')