@basis-theory/basis-theory-js
v4.17.1
Published
> [!CAUTION] > This SDK has been deprecated. > > Our new SDK can be found at https://github.com/Basis-Theory/node-sdk > > See our documentation site for more information. https://developers.basistheory.com/docs/sdks/server-side/node
Downloads
102,877
Maintainers
Keywords
Readme
Basis Theory JS SDK (aka BasisTheory.js)
[!CAUTION] This SDK has been deprecated.
Our new SDK can be found at https://github.com/Basis-Theory/node-sdk
See our documentation site for more information. https://developers.basistheory.com/docs/sdks/server-side/node
The Basis Theory JS SDK
Installation
Using Node Package Manager
npm install --save @basis-theory/basis-theory-js
Using Yarn
yarn add @basis-theory/basis-theory-js
Documentation
For a complete list of endpoints and examples, please refer to our API docs
Usage
Initialization
import { BasisTheory } from '@basis-theory/basis-theory-js';
const bt = await new BasisTheory().init('<API Key>'); // replace with your application key
Per-request configuration
All of the service methods accept an optional RequestOptions
object. This is used if you want to set a per-request BT-TRACE-ID
, BT-API-KEY
and/or BT-IDEMPOTENCY-KEY
.
import { v4 as uuid } from 'uuid';
await bt.applications.list(
{},
{
apiKey: '<Management API Key>',
correlationId: 'aa5d3379-6385-4ef4-9fdb-ca1341572153',
idempotencyKey: 'bb5d3379-6385-4ef4-9fdb-ca1341572154',
}
);
await bt.tokens.create(
{
type: "token",
data: "Sensitive Value",
},
{
apiKey: '<API Key>',
correlationId: 'aa5d3379-6385-4ef4-9fdb-ca1341572153',
idempotencyKey: 'bb5d3379-6385-4ef4-9fdb-ca1341572154',
}
);
Setting a custom API Url
You can set a custom API Url to be used across all clients when creating a new SDK instance.
import { BasisTheory } from '@basis-theory/basis-theory-js';
const bt = await new BasisTheory().init('<API Key>', {
apiBaseUrl: 'https://api.somedomain.com',
}); // replace with your application key and api base URL.
Elements
Please, refer to the Elements Documentation on how to use it.
Development
The provided scripts with the SDK will check for all dependencies, start docker, build the solution, and run all tests.
Dependencies
- Docker
- Docker Compose
- NodeJS > 10.12.0
- Yarn
Build the SDK and run Tests
Run the following command from the root of the project:
make verify