Examples of the custom API connectors

Overview

Etlworks includes hundreds of connectors for Connected Apps with built-in authentication, support for pagination, and many other features. These connectors work just like database connectors—exposing APIs as tables, views, and stored procedures.

We also provide generic HTTP API connectors with support for browser-based OAuth2-based authentication for the following widely used platforms:

• Google APIs

• Microsoft Graph APIs

• Salesforce APIs

• HubSpot APIs

• QuickBooks Online APIs

• ZOHO APIs

• Atlassian APIs

• Etlworks APIs

If the API you want to connect to is not listed above and does not require interactive browser-based authorization, but still uses OAuth2 with a token exchange or client credentials, you can use the generic HTTP connector and configure the authentication manually.

Step 1: Create a Generic HTTP Connection

1. Go to Connections → + Add Connection → HTTP.

2. Set the URL (e.g., https://api.xero.com/, https://api.spotify.com/, etc.).

3. Set the Authentication Type to OAuth2.

4. Fill in the Authentication URL, method, headers, and payload as shown in the examples below.

5. If required, configure Pagination Settings using the standard pagination support in the HTTP connector.

Example 1: Xero API

Xero uses client credentials to obtain a bearer token, which is then passed in subsequent requests.

Connection parameters

• URL: https://api.xero.com/api.xro/2.0/Invoices
  HTTP Method: GET
  
• Headers: Accept: application/json
• Pagination:  Optional (depends on endpoint; Xero supports page param)

Authentication parameters

• Authentication: oauth2
• Authentication URL: https://identity.xero.com/connect/token
• HTTP Method for Token and OAuth2 Authentication: POST
• Authentication Request Content Type: application/x-www-form-urlencoded
• Authentication Request Payload:

  grant_type=client_credentials&client_id=YOUR_CLIENT_ID&
  client_secret=YOUR_CLIENT_SECRET&scope=accounting.transactions

Example 2: Spotify API

Spotify requires a token retrieved via client credentials, which is then passed to access endpoints.

Connection parameters

• URL: https://api.spotify.com/v1/me/top/tracks
  HTTP Method: GET
  
• Headers: Accept: application/json
• Pagination: Cursor or offset (uses limit and offset query params)

Authentication parameters

• Authentication: oauth2
• Authentication URL: https://accounts.spotify.com/api/token
• HTTP Method for Token and OAuth2 Authentication: POST
• Authentication Request Content Type: application/x-www-form-urlencoded
• Authentication Request Headers: Authorization: Basic BASE64(client_id:client_secret)
• Authentication Request Payload:  grant_type=client_credentials

Example 3: DocuSign API – JWT Grant Flow

DocuSign supports JWT OAuth2, where a backend service uses a signed JWT to request an access token. 

You must create and sign the JWT yourself, using your DocuSign integration key, user ID, and private RSA key. The JWT must be signed using RS256.

Connection parameters

• URL:https://demo.docusign.net/restapi/v2.1/accounts/{account_id}/users
  HTTP Method: GET

Authentication parameters

• Authentication: oauth2
• Authentication URL: https://account.docusign.com/oauth/token
• HTTP Method for Token and OAuth2 Authentication: POST
• Authentication Request Content Type: application/x-www-form-urlencoded
• Authentication Request Payload:

  grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer
  &assertion={your_signed_jwt}