Skip to content

Authentication

This document covers details of the Notification Service Application Programing Interface (API) to publish/subscribe events from/to Novo Cloud. This API uses HTTP 1.1 protocol, and the entire HTTP body is in JSON (Java Script Object Notation) data format.

Cloud Endpoint：https://api.stage.novo.us

Authentication

To use Notification Service API, client application should provide an API Key and an API Signature.

Specify api key in your request by including it as the value of the x-tn-api_key header and specify api signature in your request by including it as the value of the x-tn-api_signature header.

Signature Generation

The API Signature is unique per request. You can create a valid API signature for your request as follows:
api­key + “:” + timestamp + “:” + MD5 (api­key + “:” + timestamp + “:” + api­secret) where timestamp is the value of UTC in seconds, such as 1393379693.

A sample Postman Pre-request script that shows how to generate these values is below

1
2
3
4
5
6
7
8
var apiKey = // <Provided API Key>
var apiSecret = // <Provided API Secret>
var timestamp = Math.round(new Date().getTime() / 1000);
var signature = apiKey + ':' + t + ':' + CryptoJS.MD5(apiKey + ':' + timestamp + ':' + apiSecret).toString();

// Use these environment in the Request Headers: x-tn-api_key and x-tn-api_signature
postman.setEnvironmentVariable("api_key", apiKey);
postman.setEnvironmentVariable('api_signature', signature);

Refer to Subscription API sections for details.