CCH Axcess Workflow REST API - Version 2 (V2) How to Authenticate & Generate Token?

Article Type:
How To
Last Modified:
09/12/2023

Objectives

To Authenticate & Generate Token

Environment

API
CCH Axcess Workflow

Procedure

REST API - Authentication and Token Generation process

A. SUMMARY
B. V1 AUTHENTICATION & TOKEN GENERATION PROCESS

1. TO AUTHENTICATE
2. TO GENERATE A TOKEN

C. SWAGGER DOCUMENTATION
D. MODEL ( SCHEMA) & EXAMPLE VALUE TO "TRY IT OUT"

A. SUMMARY

We have two types of API versions V1 and V2.
V1 - Older version ( Refer to REST API - Version 1 (V1) How to Authenticate & Generate Token?)
V2 - Updated version and all the enhancements, and improvements are added to this version.

V2 is the suggested version for REST API.

API KEY
To Authenticate and Generate tokens, an API key is required. After the subscription to REST API, the API key is provided.
To purchase API Key, please contact your Sales Rep.

B. V1 AUTHENTICATION & TOKEN GENERATION PROCESS

1. TO AUTHENTICATE

Select version V2

At the top right of your screen, click on Authorize

Copy you API Key and paste it in APIKey (apiKey) value

Now the API key is Authorized.

API Key Successfully Authorized. Now to generate TOKEN

2. TO GENERATE TOKEN

Please follow the below steps:

Go to /api/v2/authenticate/user,

Click the" Try it out" button.

Enter Username, Password

Click Execute and you will get a Token in Response.

Copy the TOKEN form the Response Body

Paste it in Bearer Token within the Authorize button at the top.

Now click on the Authorize button:

Once Security Token generated. API calls can be mode.

Note:

A token is valid for 24 hours.
For using other API products (ex. Postman), you will need to use the Base URL

(ex. https://workflow.cchaxcess.com/xcmrestservices/vnext/swagger/v2/swagger.json?firmid=xxx) also found at the top of the page.

C. SWAGGER DOCUMENTATION:

To get the Swagger File with all the details, please click on the base URL link.

V2 Rest APIs - Login to XCM Rest API using the provided credentials and view the endpoints

https://workflow.cchaxcess.com/xcmv2/account/partiallogin?ReturnUrl=/XCMRestdoc/

SCHEMA & Example Value to Try it out

SCHEMA

EXAMPLE VALUE TO "TRY IT OUT" -