Tokenization Service Node.js

This README provides instructions on how to use the Tokenization class in the Tokenization Service Node.js project.

Installation

To install the necessary dependencies, run:

npm install --save @edirect/tokenization

Important Note

This client caches the configurations for 5 minutes and the tokens for 1 minute.

This is to avoid making unnecessary requests to the tokenization service. If you want to change any configuration on the tokenization service, you'll need to wait for the cache to expire.

Usage

The Tokenization class provides methods to tokenize and detokenize payloads. Below is an example of how to use the class.

Importing the Tokenization Class

import { Tokenization } from "@edirect/tokenization";

Creating an Instance

To create an instance of the Tokenization class, you need to provide the base URL of the tokenization service.

const baseUrl = "https://tokenization-service.api.example.com";
const tokenization = new Tokenization(baseUrl);

Tokenizing a Payload

To tokenize a payload, use the tokenize method. You need to provide the authentication token, tenant, configuration, and the payload to be tokenized.

const auth = 'your-auth-token';
const tenant = 'your-tenant';
const config = 'your-config';
const payload = {
    name: 'John Doe',
    email: '[email protected]',
    phone: '123-456-7890'
    payment: {
        cardNumber: '1234 5678 9012 3456',
        expirationDate: '12/23',
        cvv: '123'
    }
};

const tokenizedData = await tokenization.tokenize(auth, tenant, config, payload);
console.log('Tokenized Payload:', tokenizedData);

Detokenizing a Payload

To detokenize a payload, use the detokenize method. You need to provide the authentication token, tenant, configuration, and the payload to be detokenized.

const detokenizedData = await tokenization.detokenize(auth, tenant, config, payload);
console.log("Detokenized Payload:", detokenizedData);

Parsing the Token

The tokenized payload is a string that contains the tokenized values. To parse the tokenized payload, you can use the parseToken method.

const token = Tokenization.parseToken("token:tenant1:str:asdf1234");
console.log(`Is Token: ${token.isToken}`);
console.log(`Tenant: ${token.tenant}`);
console.log(`Type: ${token.type}`);
console.log(`Hash: ${token.Hash}`);

API

Tokenization

constructor(baseUrl: string)

Creates an instance of the Tokenization class.

• baseUrl: The base URL of the tokenization service.

tokenize(auth: string, tenant: string, config: string, payload: TokenPayload): Promise<TokenPayload>

Tokenizes the given payload.

• auth: The authentication token.
• tenant: The tenant to tokenize the payload for.
• config: The configuration for tokenization.
• payload: The payload to tokenize.

detokenize(auth: string, tenant: string, config: string, payload: TokenPayload): Promise<TokenPayload>

Detokenizes the given payload.

• auth: The authentication token.
• tenant: The tenant to detokenize the payload for.
• config: The configuration for detokenization.
• payload: The payload to detokenize.