General Information

The Reseller API allows users to perform a variety of Portal-related data operations via RESTful services.

Requirements

  1. You must be a customer.
  2. You must request access to the Reseller API be granted to your Company through Client Success or a Support ticket.
  3. You must configure a Reseller API Key using the Portal API Management page on the Client Portal.

Integration

1614

Reseller API Setup

The Reseller API uses Basic Authentication for the Authorization header value. To determine your Authorization value, perform the following steps:

  1. Generate a Reseller API Key ID (A) and API Key pair (B) and ensure the requestor's IP is whitelisted (C) using the Reseller API Management page on the Client Portal.
  2. Concatenate the API Key ID and the API Key, with a colon separating the values (i.e. ApiKeyID:ApiKey)
  3. Generate a Base64-encoded string of the concatenated values. This is your Authorization value.

Example

DataValue
API Key IDASDF1234asdf
API Key1234567890123456789012345678901234567890
Concatenated ValueASDF1234asdf:1234567890123456789012345678901234567890
Base64-Encoded ValueQVNERjEyMzRhc2RmOjEyMzQ1Njc4OTAxMjM0NTY3ODkwMTIzNDU2Nzg5MDEyMzQ1Njc4OTA=

Using the example above, your Authorization value would be QVNERjEyMzRhc2RmOjEyMzQ1Njc4OTAxMjM0NTY3ODkwMTIzNDU2Nzg5MDEyMzQ1Njc4OTA=