Getting started

Using this portal

This portal contains different types of documentation:

API reference documentation

The reference documentation for Talend APIs is located in the APIs tab. In the left panel of each API, you can find:

• A Try in API Tester button to open the API in your Talend API Tester Google Chrome extension if it is already installed. If it isn’t installed, the button opens the Google Chrome Web Store to install the Free Edition. For more information, see Try in API Tester.
• A Download button to download the API contract in the OAS 3.0 or Swagger 2.0 format.

In each operation in the API, you can find:

• A Request section listing the parameters available for the request.
• A Response section describing the different possible responses for the request.
• If any use cases using this operation exist, a Use cases section containing the links to these use cases.
• A Try in API Tester button allowing you to open the operation in API Tester.

Use cases

The Use cases tab contains examples of the APIs in use. Each page gives a step-by-step tutorial to perform a specific action using one of the endpoints available. In the left panel of each page, you can find a link to the reference documentation for the operation used.

Authenticating to Talend APIs

To use Talend APIs, you need to use the Authorization header for authentication. You can access the APIs using:

• A Personal Access Token, generated through the Talend Cloud portal. For more information, see Generating a Personal Access Token on Talend Help Center.
• A Service Account Token, generated using the Service Account API. For more information, see Generating a service account token.

Trying APIs in API Tester

The Try in API Tester button in the left panel of the API reference documentation pages opens the Talend API Tester extension and creates a new test project containing:

• All the operations in the API with their query parameters and headers.
• An environment variable named BaseUrl with the selected endpoint.
• An environment variable for each authentication method available.

When you click the button for a specific operation in the right panel, it only created a draft request with its query parameters and headers.

For more information about using API Tester, see the Talend Cloud API Tester User Guide.