@signet-labs/signet-ts-sdk
v0.1.2
Published
Signet API SDK for TypeScript/JavaScript - Bearer token (v1) and DPoP (v2) authentication
Downloads
326
Maintainers
Readme
Signet API SDK
TypeScript/JavaScript SDK for the Signet API with Bearer token (v1) and DPoP (v2) authentication support.
Installation
npm install @signet-labs/signet-ts-sdk
# or
yarn add @signet-labs/signet-ts-sdk
# or
pnpm add @signet-labs/signet-ts-sdkUsage
Bearer Token (v1)
Pass basePath, apiKey, and apiSecret once. The SDK handles token fetch and refresh automatically.
import { Partner } from '@signet-labs/signet-ts-sdk';
import { createBearerConfiguration } from '@signet-labs/signet-ts-sdk/utils/bearer';
const config = createBearerConfiguration({
basePath: 'https://api.getsignet.xyz',
apiKey: 'pk_live_abc123',
apiSecret: 'sk_live_xyz789',
});
const partner = new Partner(config);
const clients = await partner.clients.allClients();API structure: [service].[category].[endpoint]
import { Partner, Credentials } from '@signet-labs/signet-ts-sdk';
const partner = new Partner(config);
await partner.clients.allClients();
await partner.clients.getClient({ clientId: '...' });
await partner.clients.registerClient({ registerClientBodyDto: { name: 'Jane', email: '[email protected]' } });
const credentials = new Credentials(config);
await credentials.enrollment.enrollUser({ enrollmentBodyDto: { ... } });
await credentials.mandate.createCartMandate({ ... });DPoP (v2) - Token Binding
For enhanced security with DPoP (token bound to cryptographic key), use the DPoP utilities. See DPoP documentation for the full flow.
import { DPoPManager } from '@signet-labs/signet-ts-sdk/utils/dpop';API Reference
- Partner:
partner.clients.allClients,partner.clients.getClient,partner.clients.registerClient, etc. - Credentials:
credentials.enrollment.enrollUser,credentials.mandate.createCartMandate, etc.
License
MIT
Author
Rafal Zacher (CTO @ Signet Tech, inc.)
