Articles in this section

Using Pre-Configured API Connectors

  • Updated
Follow

Etlworks provides a collection of pre-configured connectors for popular APIs that use OAuth2, API keys, or other authentication methods. These connectors simplify authentication, URL setup, and dynamic token management. This article explains how to configure and use these connectors effectively, including pagination options.

Available Connectors

Microsoft Services and APIs

1. Connector: Select Microsoft APIs connector.

2. Permissions: Select or enter one or more permissions. If the required permission is not listed, you can type it manually.

3. Authentication: Click Sign in with Microsoft to authenticate. A refresh token will be saved and used to dynamically generate access tokens at runtime.

4. Endpoint Configuration:

    • Set the URL and Method.

    • Configure pagination by setting Pagination Type to cursor or url, and use /nextLink or /@odata.nextLink as Next Token JSON Path, depending on the API.

Google Services and APIs

1. Connector: Select Google APIs connector.

2. Scopes: Enter OAuth2 scopes as a space- or comma-separated list.

3. Authentication: Click Sign in with Google. A refresh token will be retrieved and used to obtain access tokens automatically.

4. Endpoint Configuration:

    • Set URL and Method.

    • For paginated APIs like Google Drive, use /nextPageToken as the Next Token JSON Path.

Salesforce APIs

1. Connector: Select Salesforce APIs connector.

2. Authentication: Click Sign in with Salesforce to retrieve and store the refresh token.

3. Endpoint Configuration:

    • Set URL and Method.

    • Use /nextRecordsUrl as Next Token JSON Path for paginated Salesforce queries.

HubSpot APIs

1. Connector: Select HubSpot APIs connector.

2. Scopes: Enter scopes separated by spaces or commas.

3. Authentication: Click Sign in with HubSpot to store refresh token.

4. Endpoint Configuration:

    • Set URL and Method.

    • Use /paging/next/after as Next Token JSON Path when applicable.

QuickBooks Online APIs

1. Connector: Select QuickBooks Online APIs connector.

2. Scopes: Optional, enter if needed.

3. Authentication: Click Connect to QuickBooks.

4. Endpoint Configuration:

    • Set URL, Method, and Accept header.

    • Use /QueryResponse.startPosition or similar depending on the operation.

Note: Use <environment> (auto-detected: quickbooks.api or sandbox-quickbooks.api) and <realmId>(company ID) as tokens in the URL.

ZOHO APIs

1. Connector: Select one of the Zoho APIs connectors.

2. Connected App: Use your own Zoho app (recommended) or the Etlworks default for testing.

Read why it is better to use an app created under your account.

3. App ID / Secret: Enter your connected app credentials or leave blank to use default.

4. Scopes: Enter scopes separated by space or comma.

5. Authentication: Click Sign in with Zoho.

6. Endpoint Configuration:

    • Set URL and Method.

Note: <region> token in URL is resolved automatically.

Atlassian APIs

1. Connector: Select one of the Atlassian APIs connectors.

2. Atlassian URL: e.g., https://<yoursitename>.atlassian.net

3. Permissions: Enter space- or comma-separated list.

4. Authentication: Click Sign in with Atlassian.

5. Endpoint Configuration:

    • Set URL and Method.

Note: <cloudId> is auto-detected.

Amazon Marketplace APIs (SP-API)

1. Connector: Select Amazon Marketplace APIs connector.

2. Marketplace: Select the correct marketplace.

3. Authentication: Click Sign in with Amazon.

4. Endpoint Configuration:

    • Set URL and Method.

    • Use /nextToken or /pagination.nextToken depending on the SP-API version.

Note: <region> is resolved based on account.

Etlworks APIs (Built-in and User-Defined)

Etlworks API connector allows creating connections for built-in and user-defined Etlworks APIs. 

1. Connector: Select Etlworks APIs connector.

2. Endpoint Configuration:

Etlworks APIs have a Base URL to which the endpoint paths are appended, for example, https://app.etlworks.com. If Base URLis not entered, the connector will use the default URL defined under Settings->General->Home URL.

To configure Endpoint:

    • Select or enter Endpoint Path and optional Base URL.

    • Default method is pre-set for known endpoints.

3. Authentication:

    • Enter User, Password, and optional 2FA Secret and Tenant ID.

Note: Use tokens like {user}, {password}, {tenant} in headers or URLs.

If Two-Factor Authentication is enabled for the Etlworks account, enter 2FA Secret. To get the secret, if you have already enabled the 2FA for your account, go to About->Two-Factor Authentication->Add new device->Enter password->view secret. To get the secret, if you are in the process of enabling the 2FA for the account, go to About->Two-Factor Authentication->Enable->view secret.

API Key Authentication with Etlworks API Connector

When using API Key authentication, the username, password, 2FA Secret, and tenant settings are disregarded. Please note, there is no automatic tenant switch. To execute the API for a specific tenant, ensure that the user associated with the API Key is explicitly assigned to that tenant.

  • Use the Password field for the API key.

  • Insert {password} as a token in the URL or Headers.

  • Do not enter User, 2FA Secret, or Tenant. The system uses only the API key.

  • The user associated with the API key must belong to the target tenant.

Notes on Pagination

Most pre-configured API connectors support built-in pagination. After setting the endpoint:

  • Set Pagination Type: cursor, url, or page.

  • Define Next Token JSON Path using / notation (e.g., /paging/next/after).

  • If required, set Token Parameter Name, Initial Token, and Data JSON Path.

Refer to Using Built-In Pagination for HTTP API Connector for a detailed guide.

Related articles

Comments

0 comments

Please sign in to leave a comment.