CCH Axcess Workflow REST API - Version 1 (V1) How to Authenticate & Generate Token?
- Article Type:
- How To
- Last Modified:
- 01/30/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
B. V1 AUTHENTICATION & TOKEN GENERATION PROCESS
1. TO AUTHENTICATE
2. TO GENERATE A TOKEN
2. TO GENERATE A TOKEN
C. SWAGGER DOCUMENTATION
D. MODEL ( SCHEMA) & EXAMPLE VALUE TO "TRY IT OUT"
D. MODEL ( SCHEMA) & EXAMPLE VALUE TO "TRY IT OUT"
A. SUMMARY
We have two types of API versions V1 and V2.
V1 - Older version
V2 - Updated version and all the enhancements, and improvements are added to this version.
V2 is the suggested version for REST API. (Refer REST API - Version 2 (V2) How to Authenticate & Generate Token? )
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 V1
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/v1/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
Copy the token from Response body to execute the API's
V1 (Version 1) - . In V1, to Execute the API calls, the generated TOKEN need to be pasted in "Securitytoken" field everytime.
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/swagger/docs/v1?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.
To get the Swagger File with all the details, Please click on the base URL link.
V1
D. MODEL (SCHEMA) & EXAMPLE VALUE TO "TRY IT OUT"
MODEL
EXAMPLE VALUE TO "TRY IT OUT" -
- Click on Try it out, Enter the parameters in the Example Value to test the API
- Copy the Security Token and paste it under "Securitytoken" field
- Click on Execute
Additional Information
Solution Id | 000258124/REST-API-Version-1-V1-How-to-Authenticate-Generate-Token |
---|---|
Direct Link |