Signet API SDK

TypeScript/JavaScript SDK for the Signet API with built-in DPoP (Distributed Proof of Possession) authentication support.

Installation

``bash
npm install @signet/sdk


or

yarn add @signet/sdk

or

pnpm add @signet/sdk
`

Usage

$3

`typescript
import { Configuration, PartnerApi } from '@signet/sdk';
import { generateDPoPKeyPair, createDPoPProof } from '@signet/sdk/utils/dpop';

// Initialize SDK
const config = new Configuration({
basePath: 'https://api.getsignet.xyz',
});

// Generate DPoP key pair
const keyPair = await generateDPoPKeyPair();

// Create DPoP proof for token request
const dpopProof = await createDPoPProof(keyPair, {
method: 'POST',
url: 'https://api.getsignet.xyz/oauth/token',
});

// Use SDK with DPoP
const api = new PartnerApi(config);
// DPoP will be automatically included in requests
`

$3

`javascript
const { Configuration, PartnerApi } = require('@signet/sdk');
const { generateDPoPKeyPair, createDPoPProof } = require('@signet/sdk/utils/dpop');

// Initialize SDK
const config = new Configuration({
basePath: 'https://api.getsignet.xyz',
});

// Generate DPoP key pair
const keyPair = await generateDPoPKeyPair();

// Create DPoP proof for token request
const dpopProof = await createDPoPProof(keyPair, {
method: 'POST',
url: 'https://api.getsignet.xyz/oauth/token',
});

// Use SDK with DPoP
const api = new PartnerApi(config);
``

$3

The SDK includes DPoP utilities for secure token binding. See the DPoP documentation for detailed usage.

API Reference

This SDK provides access to the following API services:

- Credentials API: User enrollment and credential management
- Fraud API: Fraud detection and reporting
- Partner API: Partner and client management

License

MIT

Author

Rafal Zacher (CTO @ Signet Tech, inc.)