Your use of this site is conditioned on Your continued compliance with the Terms of Use.

I have read Terms of Use. I am aware I may use the Site and/or its Content for personal use only in accordance with the Terms of Use, as a part of my relationship with ABBYY. It’s expressly forbidden to use the Site and/or its Content for competitive and benchmarking purposes.

IF YOU DO NOT AGREE, DO NOT USE THE SITE.

Terms of Use

The sites https://www.abbyy.com/, https://help.abbyy.com/ and other ABBYY-owned sites (collectively, “Site”) are the property of ABBYY Development Inc. and affiliates, the ABBYY group companies ("ABBYY") and its licensors. BY USING THE SITE, YOU AGREE TO THESE TERMS OF USE; IF YOU DON’T AGREE, DO NOT USE THE SITE.

The services and information that ABBYY provides to You are subject to the following Terms of Use (referred to as “Terms”). ABBYY reserves the right, at its sole discretion, to change, modify, add or remove portions of these Terms, at any time. It is Your responsibility to check these Terms for amendments. ABBYY reserves the right to do any of the following, at any time, without notice: to modify, suspend or terminate operation of or access to the Site, or any portion of the Site, for any reason; to modify or change the Site, or any portion of the Site; and to interrupt the operation of the Site or any portion of the Site for maintenance or other reason. You may not use the Site or any Content for any purpose that is unlawful or prohibited by these Terms, or to solicit the performance of any illegal activity or other activity which infringes the rights of ABBYY or others. You agree that ABBYY may, in its sole discretion and without prior notice, terminate Your access to the Site and/or block Your future access to the Site if ABBYY finds that You have violated these Terms or other agreements. You agree that any violation by You of these Terms will constitute an unlawful and unfair business practice. You agree that ABBYY may, in its sole discretion and without prior notice, terminate Your access to the Site. You agree that ABBYY will not be liable to You or to any third party for termination of Your access to the Site as a result of any violation of these Terms.

Your continued use of the Site means that You agree to the amendments. As long as You comply with these Terms, ABBYY grants You a personal, non-exclusive, non-transferable, limited right to enter and use the Site.

Disclaimer of Warranty

All materials contained herein, the Site and any Content, service or features are provided "AS IS" and "AS-AVAILABLE" without warranty of any kind. ABBYY disclaims all warranties of any kind, including all warranties and conditions of accuracy, merchantability, whether express implied or statutory, fitness for a particular purpose, defects-free, virus-free, contamination title and non-infringement, specific results warranty. Any use of the materials of this site is at Your own discretion and risk and You are solely responsible for any damage to Your computer system, including but not limited to loss of data.

ABBYY DISCLAIMS ALL LIABILITY FOR THE ACTS, OMISSIONS AND CONDUCT OF ANY THIRD PARTIES IN CONNECTION WITH OR RELATED TO YOUR USE OF THE SITE AND/OR ANY SERVICES. YOU ASSUME TOTAL RESPONSIBILITY FOR YOUR USE OF THE SITE AND ANY LINKED SITES AND PAGES. YOUR SOLE REMEDY AGAINST ABBYY FOR DISSATISFACTION WITH THE SITE OR ANY CONTENT IS TO STOP USING THE SITE OR ANY SUCH CONTENT.

Limitation of Liability

Under no circumstances shall ABBYY be liable for any kind of damages, indirect or consequential, exemplary, incidental or punitive damages, including, without limitation loss of profits or revenues and/or costs of replacement goods and all damages resulting from (i) downloading of any software available, (ii) use of the Content or the Site, or the service, or the software, (iii) ABBYY's failure to provide services, whether in action of contract, negligence or other tortuous action even if ABBYY has been informed in advance of the possibility of such damages.If, notwithstanding the other provisions of these Terms, ABBYY is found to be liable to You for any damage or loss which arises out of or is in any way connected with Your use of the Site or any Content, ABBYY’s liability shall in no event exceed fifty US dollars. Some jurisdictions do not allow limitations of liability, so the foregoing limitation may not apply to You.

Transmission and Submission of Information

ABBYY does not guarantee the security of any information transmitted to or from the Site. Any material, information or other communication You transmit or post to this Site will be considered non-confidential. ABBYY will have no obligations with respect to such communications. Additionally, by using the Site, You acknowledge and agree that Internet transmissions are never completely secure. You understand that any message or information You send to the Site may be read or intercepted by others.

By transmitting or posting any information You grant ABBYY an unrestricted royalty free right to copy, disclose, distribute, otherwise dispose and use of such information.

While browsing through this site You agree to refrain from posting or transmitting to or from this Site any unlawful material that may violate any domestic and/or international legislation.

ABBYY may at it's own discretion monitor or review any areas on this site where users transmit or post materials or communicate solely with each other, including but not limited to any kind of chat rooms or user forums. ABBYY will have no liability related to the content of any such areas.

Relevant ABBYY Privacy Policy (Notice) and Cookie Policy (if applicable) apply to use of this Site, and its terms are made a part of these Terms by this reference. In conflict, Privacy Policy (Notice) and Cookie Policy provisions prevail. If You choose to provide ABBYY with your personal information (including but not limited to via web-forms located at the Site), your personal information will be treated in accordance with relevant Privacy Policy (Notice) which is available via link displayed on the same webpage where such information is collected.

Downloads

Any software that is made available to download from this Site is the copyrighted work of ABBYY and/or its suppliers. Such software shall be used in accordance with the respective terms of the end user license agreement (EULA) or terms of service which accompany the software. Any use of the Software not in accordance with the respective agreement is expressly prohibited. ABBYY’s obligations, if any, with regard to its products and services are governed by the agreements pursuant to which they are provided, and nothing on this Site should be construed to alter such agreements.

Should ABBYY make available certain materials for downloading from the Site and expressly agree upon it, You may use information on ABBYY products and services, provided that You (a use such information only for Your personal, non-commercial informational purpose, (b) make no modifications to any such information (c) do not remove any proprietary notices in all copies of such documentation, and (d) not make any additional representations or warranties relating to such documentation. It is expressly forbidden to use the Site or its Content for benchmarking and competitive purposes.

If there is a conflict between these Terms and the terms posted for or applicable to a specific portion of the Site or for any service offered on or through the Site, the latter terms shall control with respect to Your use of that portion of the Site or the specific service.

ABBYY may make changes to any products or services offered on the Site, or to the applicable prices for any such products or services, at any time, without notice. The materials on the Site with respect to products and services may be outdated, and ABBYY makes no commitment to update the materials on the Site with respect to such products and services. ABBYY provides access to ABBYY international data and documentation and may contain references to products and services that are not offered in every country. Such reference does not imply that ABBYY intends to offer such products or services in Your country. Although the Site is accessible worldwide, not all features, products or services referenced or offered through or on the Site are available to all persons or in all geographic locations. ABBYY reserves the right to limit, in its sole discretion, the provision and quantity of any Content, feature, product or service to any person or geographic area. Any offer for any feature, product or service made on the Site is void where prohibited.

Use of Content

All the text, communications, software, scripting, photos, text, video, visual interfaces, graphics, trademarks, logos, music, sounds, images, artwork and computer code and other materials (collectively "Content") are owned, controlled or licensed by or to ABBYY and are protected by intellectual property, competition laws and are provided by ABBYY as a service to its customers only and is exclusively for personal use. Except as expressly provided in these Terms, You may not use any portion of this Site or the Content without ABBYY’s express prior written consent. Usage for benchmarking or competitive purpose is expressly prohibited.

Trademarks

The trademarks, logos, and service marks (collectively "Trademarks") appearing on the ABBYY website are the property of ABBYY, its licensorsand other third-parties. All Trademarks are provided for Your information and do not grant You a license to use them. Neither title nor intellectual property rights are transferred to You.A list of third-party Trademarks and patents is available here.

Links to Third-Party Sites

This site may provide links to other third-party sites. ABBYY makes no representations whatsoever about any other site which You may access through this site. You acknowledge and agree that ABBYY is not responsible for the content of any linked site or any link contained in a linked site.

References on this site to any names, marks, products or services of any third parties or hypertext links to third party sites or information are provided solely as a convenience to You. ABBYY does not endorse or recommend content of such sites.

Mentioning non ABBYY products or services is for informational purposes only and constitutes neither an endorsement, nor a recommendation.

Foreign Legislation

These Terms constitute the entire agreement between You and ABBYY with regard to Your use of the Site, and any and all other written or oral agreements or understandings previously existing between You and ABBYY with respect to such use are hereby superseded. ABBYY’s failure to enforce strict performance of these Terms shall not be construed as a waiver by ABBYY of any provision or any right it has to enforce these Terms, nor shall any course of conduct between ABBYY and You or any other party be deemed to modify any provision of these Terms. These Terms shall not be interpreted or construed to confer any rights or remedies on any third parties.

ABBYY does not warrant compliance with any foreign legislation. If You access the Site, You are solely responsible for compliance with all applicable local laws.

You may not use or export or re-export any Content or any copy or adaptation of such Content, or any product or service offered on the Site, in violation of any applicable laws or regulations, including without limitation international export control laws and regulations, and/or for competition and benchmarking.

Subscription Terms

The Subscription terms incorporate terms on subscription, billing and payment procedure for the use of ABBYY Software on a subscription-based model. You can review the full terms here.

Partner Subscription Terms

The Partner Subscription Terms incorporate terms on subscription, billing and payment procedure for the use of ABBYY Software on a Subscription-based model by partners. You can review the full terms here.

May 2021

Registering OAuth Client in Timeline

To prepare for interaction with Timeline API, you need to register an OAuth client in your Timeline account beforehand. Registering such a client will allow exchanging information between your 3rd party system and Timeline:

The external system will receive some security credentials to interact with Timeline. Using those credentials your system will be able to retrieve information from Timeline API resources.
You will provide to Timeline the endpoint that should be prepared in your system for Timeline to interact with.

Access tokens are issued according to the OAuth client settings and are tied to it for management and security purposes. In other words, the OAuth client binds a 3rd party system to Timeline.

Important. You need to have an Account Owner or Admin role to be able to access the account section in Timeline, so the same access level is needed to create a new OAuth connection.

Follow the instructions below to set up the OAuth connection properly:

Log into your Timeline account.
Go to the account section by clicking your user avatar at the bottom of the left bar and then selecting Account. Then open the OAuth & OpenID Connect tab.
Click on +Register client.
In the opened dialog, fill in the client details fields with the information about your system:

Name
Enter a name to identify the new OAuth client.
App URL
Provide a link to your application's homepage. Users will see this link when asked to grant access to their information held in Timeline. This link is not involved in the connection process, its main objective is to give users a possibility to see what they are giving access to and make sure that it is a familiar and trusted system.
Redirect URI
Specify the Redirection Endpoint to be used to provide the OAuth Authorization Response. This should be the full URL of an endpoint in your application or system which you want to connect to Timeline. Since Timeline API is guarded by OAuth 2.0, this endpoint should be able to exchange an authorization code received from Timeline for an access token. This token will be used to authenticate your API calls later.
Timeline will send an authorization code to this endpoint, and a user will be redirected to this URL after providing consent to give access to their Timeline account data.
For more information on authentication in Timeline API, required access tokens, and supported authorization flows, see Access Token.

External documentation. Learn more about Redirection Endpoint - https://www.rfc-editor.org/rfc/rfc6749#section-3.1.2

Check the preview in the Client details section.
After you fill in the information required in step 4, you can check the Client details preview with an example of what the users will see on the screen asking them for permission to share their Timeline-related information with your system. You can click on the default picture to upload your corporate logo or any other suitable image to assure users that they are interacting with a familiar and trusted system.
In the Client type section, select which client type to use depending on which fits best to your type of application:

Confidential
Select this option if your application can securely hold credentials without exposing them to unauthorized parties, and you have a trusted backend server to store secrets.
For example, if you have a web application with a user interface and a server-side component (API server, auth server, etc.) you can choose the confidential type as your server-side component will be able to securely store issued credentials.
This type is the most secure one, and we recommend using it.
Public
Your application fits this category if it cannot hold credentials securely. In this case, a client secret will not be issued for you as your application is not able to securely store it, and, for example, is running entirely in the browser.
Important. Public clients must use the Authorization Code grant with the PKCE addition.

External documentation. Learn more about Client Types - https://www.rfc-editor.org/rfc/rfc6749#section-2.1

In the Grant type section, select the authorization flow that your users will need to use to be able to authenticate their requests.
Obtaining an access token in OAuth is accomplished by performing one of the "Grant types". Timeline supports Authorization Code and Client Credentials authorization grants, aligning with the latest OAuth 2.0 Security Best Practices. In addition, a Refresh Token option is available.
External documentation. OAuth 2.0 Security Best Practices - https://datatracker.ietf.org/doc/html/draft-ietf-oauth-security-topics
Important. The Client Credentials authorization grant is not supported for API interaction at the moment, so this option is skipped in this instruction.

Select one or both of the following options:

Authorization Code
This option is selected by default. This grant type is used to exchange an authorization code for an access token. We recommended to use it since it has the most secure flow.
Also, Timeline supports the PKCE addition for this grant type, which is recommended to use if you select the Authorization Code grant type.
Refresh Token (optional)
It is a special type of token used to obtain additional access tokens. A refresh token has a longer lifespan, so it allows receiving new short-lived access tokens without having to collect credentials every time they expire.
If you would like to refresh expired access tokens for your users without additional steps, select this grant type as well.
External documentation. Learn how to refresh an expired access token - https://www.rfc-editor.org/rfc/rfc6749#section-6

Select this option to enable OpenID Connect. It allows getting certain information about authenticated end-users. If enabled, a special "openid" scope value is sent with the authorization request. This causes Timeline's Authorization Server to generate and return an id_token alongside of the access_token. The id_token provides information about the authenticated Timeline user with the values from their profile. The disclosed information can be set by selecting the needed options in the appeared Claims list: email, name, given_name, family_name, phone_number, locale, zoneinfo.

Important. After the OAuth client is registered, these selections cannot be changed.
External documentation. Read more on OpenID Connect in the official core documentation - OpenID Connect Core: https://openid.net/specs/openid-connect-core-1_0.html
For details on OpenID Connect in Timeline, see OAuth & OpenID Connect.
Select permission Scopes that will be available for this OAuth client. Scopes are tied to access tokens. This means that an issued token can grant access only to those API endpoints, which require the scopes associated with this token. For example, to get a user’s project list requires an access token with the scope that allows read-only access to Timeline projects - project:read. If this scope is not associated with the access token, the call to the endpoint fails.
Select the absolute set of scopes that an end user or an application will use:

Read projects (project:read)
Allows making GET requests to the Projects resource.
Write projects (project:write)
Allows making all kinds of requests to the Projects resource.
Read repositories (repository:read)
Allows making GET requests to the Repositories resource.
Write repositories (repository:write)
Allows making all kinds of requests to the Repositories resource.

It is recommended to select only the scopes that are really needed for the expected requests, otherwise, users interacting with this client might decline the connection because they do not want to grant more permissions than are actually needed. For example, if you expect only the requests to read the user’s project list through this client, the Read projects scope is sufficient.

When the configuration is finished, click Register. The OAuth dialog will re-open with two additional fields pre-filled: Client ID and Client Secret. These are your OAuth credentials needed for any of the supported OAuth grant types.
Note. A client secret won’t be issued if your client type is Public.

Now when you have a properly configured OAuth client that will be used when performing one of the supported OAuth authorization flows to get an access token. At the moment, for the API the Authorization code grant is required. For further instructions, see Access Token.

22.02.2024 17:28:05