CCH Axcess™ Workflow API Overview
- Article Type:
- Documentation
- Last Modified:
- 09/18/2023
Objectives
Learn about API in CCH Axcess Workflow.
Environment
XCM
APIs
CCH Axcess Workflow
CCH Axcess Workflow API
APIs
CCH Axcess Workflow
CCH Axcess Workflow API
Details
API Overview
CCH Axcess Workflow provides a diverse set of REST APIs for organizations that use Workflow. This set of APIs is termed WorkflowAPI. The APIs help to import information into, and export information out of, Workflow.
How APIs are Used
APIs can be used to add or update Client, Firm, Task, and User information in the workflow.Currently, available APIs are grouped into five categories.
- Authenticate
- Client
- Firm
- Task
- User
The APIs under each category and a brief description are detailed in the table at the end of this article.
Organizations that Would Benefit from API
API helps organizations connect Workflow with other programs that leverage client, entity, task, employee, scheduling, or time information. This helps users better scale their businesses by providing more detailed data to better assess the company and individual performance, bottlenecks, and inefficiencies.This allows users to easily compare data across management systems for a more holistic view of project statuses and business progress.
Organizations that
(1) have their own development teams
(2) have a sophisticated set of applications that are ideal candidates for API.
Prerequisites/Security
A valid login and API key are required to authenticate an API user. These credentials will be provided by the Workflow Integration team.Subsequent calls would use the API key and the token that is returned from the authentication call.
- Integrated firms (If the Axcess Workflow firm is Integrated with CCH Axcess) then the firm can use Developers Portal.
- Non-Integrated Firms (If the Axcess Workflow firm is Non-Integrated) then the firm can use the Legacy API method.
Sandbox Environment can be used for Testing
The production Environment can be used for Live Execution
CCH Axcess Workflow REST API - Version 2 (V2) How to Authenticate & Generate Token?
CCH Axcess Workflow REST API - Version 1 (V1) How to Authenticate & Generate Token?
The production Environment can be used for Live Execution
CCH Axcess Workflow REST API - Version 2 (V2) How to Authenticate & Generate Token?
CCH Axcess Workflow REST API - Version 1 (V1) How to Authenticate & Generate Token?
For more information on API
Contact your Account Manager or your Customer Service Representative/Consultant for more information.
How do I authenticate to API?
CCH Axcess Workflow will provide a unique API Key for the Workflow environment for your firm. This API Key should be provided in the header of every API request that you make.Initially, in a new session, you will need to call the authenticate/user endpoint, with the above API Key in the header, and a valid Workflow username and password in the json body.
This will return a unique token in response.
This unique token needs to be provided in the request header for all subsequent API requests for your session.
Please see our Swagger page for more details.
Note: A token is valid for 24 hours.
API Types
Here are two primary types of APIs: POST and GET.- POST APIs enable information to be updated (or searched) within Workflow.
- GET APIs to enable information to be retrieved from the Workflow
API Export and Import
API can only retrieve and update information within Workflow. It cannot pull (retrieve) or update (push) information to other applications. Such pull and push operations require the APIs of the respective applications.List of APIs by Category
V2 - Version 2
V1 - Version 1
Please login to https://workflow.cchaxcess.com/XCMRestdoc/apimanagement and select the version to see the API Categories.
Solution Id | 000219611/CCH-Axcess-Workflow-XCMAPI-Overview |
---|---|
Direct Link |