Getting Started

1. Redirect the user to the Authorization Page.

Send the user to our Authorization Page. On this page users will be given the opportunity to log in if they are not already

https://www.cx.com/mycx/oauth/authorize?client_id=[CLIENT_ID]&redirect_uri=[RedirectURI]

Note: the RedirectURI must be secure [ https ] - not http.
Note: the accept header must be set to: 'application/json' 

2. User approves your application.

Users are asked if they want to grant your application access. Once the user approves your application, they will be redirected to your RedirectURI with the Authorization Code in the code url parameter.

Example:

https://[yourapp.com/somePath]?auth_code=hn2wkyxqu2ab8uhv2zvhpfxz

If the user choses to deny authorization for your application, they are redirected to your RedirectURI with the url parameter deny set to true.

Example: 

https://[yourapp.com/somePath]?deny=true

3. Request the access_token for the user's account. 

With the Authorization Code, your application makes a request to CX for the access_token. 

curl -v -H "Authorization: Basic <base64 encoded CLIENT_ID:CLIENT_SECRET>" -d "grant_type=authorization_code&code=[AUTH_CODE]&redirect_uri=[RedirectURI]" 'https://api.cx.com/1/oauth/token'

Things to note:

• The RedirectURI must be your same redirect uri from the authentication
• You must POST the parameters
• You must set the Authorization information in the Header of your request
• The Content-Type must be multipart/form-data 

Example Request using curl:

auth_code=YOUR_AUTH_CODE
redirect=YOUR_REDIRECT_URI
client_id=YOUR_CLIENT_ID
client_secret=YOUR_CLIENT_SECRET  
secret=`echo "${client_id}:${client_secret}" | base64`

curl -v -H "Authorization: Basic ${secret}" \
   -d "grant_type=authorization_code&code=${auth_code}&redirect_uri=${redirect}" \
   'https://api.cx.com/1/oauth/token'

Example Request using Python:

import requests
import base64

#Your auth code from step 2   
auth_code=YOUR_AUTH_CODE

#Your Redirect URI, which must be the same as in in the Authorization step 
redirect=YOUR_REDIRECT_URI

#your Application API Key 
client_id=YOUR_CLIENT_ID

#Your Shared Secret  
shared_secret=YOUR_CLIENT_SECRET  

#need to set the header value for Authorization 
headers = {'Authorization': 'Basic ' + secret}

#create a dictionary for the form post elements  
tokenPayload = {'grant_type': 'authorization_code', 'code':auth_code, 'redirect_uri':redirect}

#set the url of the token request 
url = 'https://api.cx.com/1/oauth/token'

#using python requests object, post to the url with the dictionary value and headers 
r = requests.post(url, headers=headers, data=tokenPayload) 

Example Response:

{"return_type":"json","access_token":"[Access Token]","token_type":"bearer"}

Unless otherwise specified, all requests will require the access_token parameter.