Orvio SDK

Official SDK for Orvio OTP and Verification Services.

Installation

1npm install @orvio/sdk

Usage

1import OrvioClient from '@orvio/sdk';
2
3// Initialize the client
4const client = new OrvioClient('your_api_key');
5
6// Send OTP
7const { tid } = await client.create('+1234567890', {
8  webhookUrl: 'https://your-server.com/webhook',
9  webhookSecret: 'your_webhook_secret',
10  orgName: 'Your Company'
11});
12
13// Verify OTP
14const result = await client.verify(tid, '123456');
15
16// Get credit information
17const credits = await client.getCredits();
18console.log(`Balance: ${credits.balance}, Mode: ${credits.mode}`);
19
20// Create a new API key
21await client.createApiKey('Production Key', { orgName: 'Your Company' });
22
23// Webhook handler example (Express)
24app.post('/webhook', express.raw({type: 'application/json'}), (req, res) => {
25  const signature = req.headers['x-signature'] as string;
26  const payload = req.body.toString();
27  
28  if (!OrvioClient.verifyWebhookSignature(payload, signature, 'your_webhook_secret')) {
29    return res.status(403).send('Invalid signature');
30  }
31
32  const event = JSON.parse(payload);
33  // Handle webhook event
34  res.status(200).send('OK');
35});

Documentation

Sending an OTP

1create(phoneNumber: string, options?: CreateOtpOptions): Promise<CreateOtpResponse>

Verifying an OTP

1verify(tid: string, userInputOtp: string): Promise<VerifyOtpResponse>

Credit Management

1getCredits(): Promise<CreditInfo>
2getStats(): Promise<UserStats>

API Key Management

1getApiKeys(): Promise<ApiKey[]>
2createApiKey(name: string, options?: CreateApiKeyOptions): Promise<void>

Webhook Verification

1static verifyWebhookSignature(payload: string, signature: string, webhookSecret: string): boolean

Types

CreateOtpOptions

1interface CreateOtpOptions {
2  webhookUrl?: string;
3  webhookSecret?: string;
4  orgName?: string;
5}

CreditInfo

1interface CreditInfo {
2  balance: number;
3  mode: string;
4}

CreateApiKeyOptions

1interface CreateApiKeyOptions {
2  orgName?: string;
3}

License

MIT