Conviva API Authentication
Conviva API system accepts only API client-based credentials. Generate API credentials in the Pulse API Management page to get a pair of {id} and {secret}.
Note: Do not use your Pulse user-based credentials for any API request.
Use HTTP's Authorization Basic scheme for API authentication:
-
Concatenate the API credential's {id} and {secret} with a single colon : character, like {id}:{secret}.
-
Use Base64 encoding scheme to encode the concatenated string.
-
Append Basic: in front of the encoded string, and place it in the Authorization request header.
For example:
const [clientId, clientSecret] = ['abcdefghij', 'z1y2x3w4v5u6t7s8r9q0p']; // API credential information
const concatenatedCredential = `${clientId}:${clientSecret}`; // concatenate with ':'
const base64EncodedCredential = Buffer.from(concatenatedCredential).toString('base64'); // base64 encoding
const httpAuthorizationHeader = `Basic ${base64EncodedCredential}`; // HTTP Authorization header value: 'Basic YWJjZGVmZ2hpajp6MXkyeDN3NHY1dTZ0N3M4cjlxMHA='
In cURL, use the --header option with the Authorization header key.
curl --header 'Authorization: Basic YWJjZGVmZ2hpajp6MXkyeDN3NHY1dTZ0N3M4cjlxMHA=' ...
Conviva API server accepts only the HTTPS secure transport communication scheme. All message content is encrypted with the HTTPS transport protocol.
Contact Conviva Support (support@conviva.com) with any questions about account credentials.