The Cinode REST API (Application Programming Interface) allows your developers to connect Cinode with other applications.
Use cases
Synchronising customer or project data in Cinode with CRM platforms
Creating dashboards on your intranet for visualising resource planning or sales data from Cinode
Synchronising external application forms on your website with Cinode
Automatically generating reports from Cinode
Displaying employee skill sets on your website or selected employee data
Importing employees from your ERP/HR platform into Cinode
Updating employee data in Cinode when updates are made in your HR platform
We encourage your team and developers to build and maintain the integrations to suit your specific needs. If required, Cinode can assist with building integrations at an additional cost. Please contact our support team for more details.
Existing integrations
If you are interested in our selection of ready-made integrations that are available as paid add-ons, please read more here.
Getting started
Contact Support: First, contact our support team to have the API enabled for your company. You must be authorized within your company to make a request for the API to be enabled, since it is used to extract data from Cinode.
Authentication Options: You can authenticate API requests in two ways. Choose the API Account method (AccessId and AccessSecret) if you prefer a setup where tokens require periodic refreshing, or the Static Token method for simpler, static tokens with an expiration date set during creation.
Using an API Account (AccessId and AccessSecret):
Start by logging into your Cinode account and expand the dropdown menu in the upper right corner of the app by clicking your name.
Select "My account" and scroll down to the "API accounts" section.
Click "+" (add) and follow the steps, including agreeing to the API Terms of Service, naming the API account, and ensuring the user enabling the API has the necessary roles.
To authenticate your API requests, you will need the following URLs:
Token Authentication URL:
https://api.cinode.app/tokenToken Refresh URL:
https://api.cinode.app/token/refresh
To obtain an access token, make a request to the Token Authentication URL using Basic Authentication:
POST https://api.cinode.app/token
Authorization: Basic {Base64Encoded(AccessId:AccessSecret)}Once the token is obtained, use it for all API requests in the Authorization header as a Bearer token:
GET /endpoint HTTP/1.1
Authorization: Bearer {your_token_here}For tokens that have expired, use the Token Refresh URL to renew them.
Using a Static Token:
Alternatively, you can generate a static token to authenticate API requests.
Navigate to Administration > Integrations > Tokens in Cinode.
When generating a token as a static token, you set an expiration date, making it straightforward to manage.
However, it is important to note that static tokens should be treated securely as they remain valid until their expiration date.
Generate a token and use it in the
Authorizationheader of your requests:GET /endpoint HTTP/1.1
Authorization: Bearer {your_token_here}This method provides a streamlined approach to authenticating API requests without using AccessId and AccessSecret.
API Account Context: Every request made to the API will be executed in the context of the owner of the API account or token. This means the user must have the appropriate combination of roles and access levels to perform the desired actions via the API. For instance, using endpoints related to creating projects (a Business feature) requires purchasing the Business module and having the "Manager" role. Learn more about roles in Cinode here.
👉 The token generated for your API requests is a JWT (JSON Web Token). By decoding this token, you can find your Company ID, which is required for most API endpoints. Use any online or offline JWT decoder to extract this information.
API Documentation
The technical API documentation describes the endpoints and includes examples. It is written so that a developer will be able to interpret the API endpoints.
You can find the documentation here: API documentation
Code examples
To help you get started, we provide code examples written in ASP.NET MVC Core (C#). The code examples are available here.
Important notes
Not all functionality in Cinode has API endpoints, so there are limitations on what data can be transferred.
The Cinode REST API can be used free of charge for a limited number of API requests. However, your company account will be billed if you surpass the maximum daily limit. Your company's administrators can view the daily number of requests and the rate limit inside the Administration interface of Cinode.