Equotix One APIs requires authentication. You will need an active subscription with Equotix One which has API access to be able to authenticate.API Domain#
The production domain for Equotix One APIs will be:https://dashboard.equotix.one/api/
API Request Methods#
The API accepts POST request for all API calls with JSON data in the body.API Response#
JSON is used for all APIs responses.Authentication Parameters#
The below POST parameters are required for all API calls to authenticate.Name | Type | Description |
---|
domain | string | The domain you are assigned to authenticate your Equotix One account. |
api_key | string | The email address assigned to the user account in your Equotix One. |
auth_timestamp | int | The unix timestamp used to sign this API request. |
auth_signature | string | The calculated signature for this API request. |
Authentication Signature Calculation#
The authentication signature is calculated by removing any object parameters from the data, then sort the remaining JSON data alphabetically by the parameter name and use the HMAC-SHA256 algorithm with your API secret.Signature Calculation Example#
Below is an example for calculating the authentication signature for a simple API request to get an item.domain = test
api_key = test@example.com
api_secret = Xv2l2mDFf1KG6WaLVZPpYbXNLpHRjF1MZMxiSSf4
auth_timestamp = 1670561053
sku = test
Sorted JSON without objects292223c3b8b7f0a79f083e62560cfb44c478fb256a457e341214310f27c2dd1a
PHP Example#
Below is the sample code for calculating the signature hash using PHP. Modified at 2024-10-21 04:36:58