@vonage/auth

Vonage Auth SDK for Node.js

This is the Vonage Auth SDK for Node.js for creating authentication headers and signature for use with Vonage APIs. To use it you will need a Vonage account. Sign up for free at vonage.com.

We recommend using this package as part of the overall @vonage/server-sdk package.

For full API documentation refer to developer.vonage.com.

• Installation
• Usage
  • Options
• Testing

Installation

We recommend using this SDK as part of the overall @vonage/server-sdk package. Please see the main package for installation.

You can also use this SDK standalone if you only need access to just the Auth SDK.

With NPM

npm install @vonage/auth

With Yarn

yarn add @vonage/auth

Usage

As part of the Vonage Server SDK

If you are using this SDK as part of the Vonage Server SDK, you can access it as the auth property off of the client that you instantiate.

The SDK can be used standalone from the main Vonage Server SDK for Node.js if you only need to use the Auth API. All you need to do is require('@vonage/auth'), and use the returned object to create your own client.

const { Auth } = require('@vonage/server-sdk');
// Or if standalone
const { Auth } = require('@vonage/auth');

const vonageAuth = new Auth({
  apiKey: API_KEY,
  apiSecret: API_SECRET,
  applicationId: APP_ID,
  privateKey: PRIVATE_KEY_PATH,
});

(async () => {
  const basicHeader = vonageAuth.createBasicHeader();
  console.log(basicHeader);
})()

Options

Options is an object with the following properties:

• apiKey - API Key from Vonage API. If applicationId and privateKey are present, apiKey is optional.
• apiSecret - API Secret from Vonage API. If applicationId and privateKey are present, apiSecret is optional.
• applicationId - (optional) The Vonage API Application ID to be used when creating JWTs.
• privateKey - (optional) The Private Key to be used when creating JWTs. You can specify the key as any of the following:
  • A Buffer containing the file contents.
  • A String containing the path to the key file on disk.
  • A String containing the key itself.

Testing

Run:

npm run test