General Overview
Getting started with the Reseller API.
Overview
The Reseller API enables our reseller participants control of their customers onboarding and account management experience. Features include management of token vaults, API keys & permissions, vault IP whitelists, proxy profiles and RSA keys.
Customers can request access to the Reseller API by opening a support ticket via the client portal or your customer success manager.
Once integration testing has been reviewed and accepted, this permission can be enabled for your production account.
Generating Credentials
Reseller API credentials are supported by self-service access. Once our team has enabled the permission, the Reseller API page link will appear in the main menu.
The Reseller API supports up to 6 API Keys at any one time. Its critical to capture the API key at the time of creation as this value will auto mask and will not be accessible at a later time. Any lost API keys require a delete event and regeneration of a new key.
Steps to Create
- Navigate to Reseller API page
- Click the green Add Credential Button
- Copy API Key/Key ID and save to your local environment
Authorization
Once you have the API Key and API Key ID you will need to leverage these values to generate your authorization value.
- Concatenate the API Key ID and the API Key, with a colon separating the values (i.e. ApiKeyID:ApiKey)
- Generate a Base64-encoded string of the concatenated values. This is your Authorization value
Example
| Data | Value |
|---|---|
| API Key ID | ASDF1234asdf |
| API Key | 1234567890123456789012345678901234567890 |
| Concatenated Value | ASDF1234asdf:1234567890123456789012345678901234567890 |
| Base64-Encoded Value | QVNERjEyMzRhc2RmOjEyMzQ1Njc4OTAxMjM0NTY3ODkwMTIzNDU2Nzg5MDEyMzQ1Njc4OTA= |
Hosts
| Environment | Host |
|---|---|
| Test | https://test-my.tokenex.com |
| Production (US) | https://my.tokenex.com |
| Production (EU) | https://eu-my.tokenex.com |
Response Codes
| Response Code | Description |
|---|---|
| 200 | OK. Successful request |
| 400 | Bad request. Review request headers and body for accuracy |
| 401 | Unauthorized. Review authorization required fields for accuracy. |
| 404 | Requested endpoint not supported. Review headers and endpoint for accuracy. |