Authentication

Timeline API is guarded by OAuth access tokens to prevent unauthorized access. Any request in Timeline must be authorized by a token, requests that do not contain a valid access token will fail. The tokens are submitted in the headers of your API requests. To receive a token, you need to set up a special OAuth connection in your Timeline account in advance.

In order to authenticate your requests, you will need to perform the following general steps:

  1. Before you begin, if you plan to use an existing project, make sure to enable the Timeline API data source in its settings. Projects where this source is inactive cannot be interacted via API.
    You can create a new project using the respective endpoint, in this case, the Timeline API data source will be enabled by default for the new project.
  2. Prepare the connection by Registering OAuth Client in Timeline
    Create an OAuth client that will be involved in the process of receiving access tokens.
    For general information about OAuth connections in Timeline, see OAuth & OpenID Connect.
  3. Test the connection to Timeline and learn more about Access Token:
    1. Acquiring an access token
      Implement one of the supported OAuth flows to acquire an access token and use it to authorize your requests.
    2. Transmitting an access token
      Submit the received access token in your request's header to authorize it.
  4. Integrate your application or system with Timeline by Implementing OAuth Grant Flow.
    Implement the OAuth flow supported by Timeline in your code base.

You can manage the already-established connections in your Timeline user profile. For example, if you have a connection that you no longer plan to use, you can revoke the granted access. To do it:  

  1. Click your user avatar at the bottom of the left bar and select Profile.
  2. Navigate to the Integrations tab.
  3. Expand the needed connection and click Revoke access.

22.02.2024 17:28:05

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.