General Information

The Portal 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 Portal API be granted to your Company through Client Success or a Support ticket.
3. You must configure a Portal API Key using the Portal API Management page on the Client Portal.

Integration

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

1. Generate a Portal API Key ID (A) and API Key pair (B) and ensure the requestor's IP is whitelisted (C) using the Portal 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

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