Getting Started
Overview
Timeline API is intended to establish a connection between Timeline and 3rd party systems and offers a wide range of opportunities. The provided resources and endpoints allow you to speed up various manual processes, optimize routine operations, like data upload, automatically download gathered statistics about your processes, and embed parts of Timeline functionality in your system. Moreover, API helps to systematize the work processes of your team, splitting them up into groups. Some of them interact with Timeline UI, and others just operate with Timeline via API requests.
Basic stages
To prepare an integration of Timeline API into your system or application, follow the general steps below:
- Learn about Timeline API opportunities.
Discover the available resources and their endpoints, required parameters, basic request and response examples. This way you consider how Timeline API could be helpful for workflows and processes and how best to integrate it.
To become familiar with API opportunities, see API reference in Swagger UI that is available by adding /open-api/1.0/apidoc.html to your Timeline instance address:
https://{your.timeline.instance}.com/open-api/1.0/apidoc.html - Set up your Timeline account for future connection with your system.
Timeline should expect requests from your system. To prepare such a background for your implementations, register your system as a client in Timeline.
For details, see Registering OAuth Client in Timeline. - Prepare your system for future interaction with the Timeline side.
To deal with API, your system should be able to authenticate in Timeline and then process responses in the correct way. This stage involves some codebase changes on your side. To build the correct implementation: - Prepare and complete Authentication.
Your system should support one of the available OAuth flows presented in Timeline. - Set up your requests.
This step requires the correct work with the Timeline resources to access various functionality.
See Resources to learn more.
Workflow guideline
To look closer at Timeline API and how it could be used in your systems, follow the sample guidelines:
- Set Up Connection Between Systems
Explore the process of connection establishment between your application and Timeline. - Dealing with Requests
Check introduction scenarios how you may use and adapt requests for your system.
05.09.2024 16:23:54