Learn the fundamentals of Equinix Cloud Exchange Fabric APIs.

 

Pre-requisites

• You have valid user credentials.
• You have been authorized to access the developer portal.
• You have been authorized permissions for orders and notifications and also to create, modify and delete connections by your master Admin.

Generating Client ID and Client Secret key

To obtain your client ID (consumer key) and client secret key (consumer secret), you must register your app in the developer platform according to your preferred environment. 

1. Login to Equinix Developer Platform using your login credentials.

 

 

2. After logging in, click on the App Dashboard section as shown below.

 

 

3. Click on the New App button.

 

 

4. You will need to name your app and then select the app type to be used, you can either create an app for the Sandbox or Production environment. Once you’re ready click on the Create button.

 

 

 

 

5. You should now have your app listed in the My Apps section as shown below:

 

 

6. When you click on your app, your Client ID ( Consumer Key) and Client Secret (Consumer Secret) will be revealed.

 

 

Requesting Access and Refresh tokens

Access Token Flow

 

The access token is used to exchange data with the Equinix APIs and the refresh token is used to request a new access token should the access token expire. You can obtain your access token by either using the password or client credentials grant type as shown in the sample curl commands below:

 

 

Access token using password grant type

 

 

Access token using client credentials grant type  (Recommended)

 

The description of the body parameters is as follows:

 

Body Parameter Name	Mandatory	Type	Example	Applicable Values	Description
grant_type	Yes	string	password	"password" "client_credentials"	Different ways to authorize access to resources. It indicates the type of grant to be presented in exchange for an access token.
user_name	Yes	string	john.doe@example.com		The Equinix login username. This field is optional for client credentials grant type.
user_password	Yes	string	jd1@#$		The Equinix login password. This field is optional for client credentials grant type.
client_id	Yes	string	ABCDE12345		A special ID generated by the Equinix Developer Platform.
client_secret	Yes	string	FGHIJ67890		A special key generated by the Equinix Developer Platform.
password_encoding	No	string	md5-b64	"md5-b64"	An optional field for users who wish to encrypt their password when requesting an access token. Currently, only “md5-b64” hashing is supported. This field is only applicable to users who use password grant.      Click here to learn how to encrypt your password using md5-b64 hashing.

 

 

 

Once authenticated, the respective token and timeout details will be sent to you as shown in the sample JSON responses below.

 

Sample response when using password grant type

 

 

 

Sample response when using client credentials grant type

 

 

The description of the response payload is as follows:

 

Field Name	Type	Example	Applicable Values	Description
access_token	string	qwErtY8zyW1abcdefGHI		The authorization token to be used in subsequent API calls.
token_timeout	string	3600		The lifetime of an access token in seconds. For example, the value "3600" denotes that the access token will expire in one hour from the time the response was generated.
user_name	string	john.doe@example.com		The Equinix login username.
token_type	string	Bearer	"Bearer"	The type of token.
refresh_token	string	zxcvbn1JKLMNOPQRSTU		Access tokens have limited lifetimes. If your application needs access to an API beyond the lifetime of a single access token, you can obtain a refresh token. A refresh token allows your application to obtain new access tokens. This information is only applicable to "password" grant users.
refresh_token_timeout	string	5184000		The lifetime of a refresh token in seconds. For example, the value "5184000" denotes that the refresh token will expire in 60 days from the time the response was generated. This information is only applicable to "password" grant users.

 

 

Refresh Token Flow

 

You can use a valid refresh token to obtain new access tokens to be used in API calls. A refresh token is valid for 60 days. You must submit your Client ID, Client Secret and Refresh Token to obtain refresh access tokens as shown in the sample curl command below.

 

 

The description of the body parameters are as follows:

 

Body Parameter Name	Mandatory	Type	Example	Applicable Values	Description
client_id	Yes	string	ABCDE12345		A special ID generated by the Equinix Developer Platform.
client_secret	Yes	string	FGHIJ67890		A special key generated by the Equinix Developer Platform.
refresh_token	Yes	string	zxcvbn1JKLMNOPQRSTU		A refresh token allows your application to obtain a new access token and is provided in the response payload of an access token call.

 

Once requested, a new set of access token, refresh token, and timeout details will be sent to you.