@edirect/tokenization

@edirect/tokenization is a Node.js client for the Tokenization Service, providing methods to securely tokenize and detokenize sensitive data. It supports caching of configurations and tokens to reduce unnecessary requests.

Features

• Tokenize and detokenize payloads with a simple API
• Caches configurations (5 min) and tokens (1 min) for efficiency
• Supports parsing and validation of token strings

Installation

pnpm add @edirect/tokenization
# or
npm install @edirect/tokenization

Caching Behavior

This client caches configurations for 5 minutes and tokens for 1 minute to avoid unnecessary requests. If you update configurations on the tokenization service, allow cache expiry before expecting changes.

Usage

The Tokenization class provides methods to tokenize and detokenize payloads.

Importing the Tokenization Class

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

Creating an Instance

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

Tokenizing a Payload

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

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

Parsing the Token

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.