From a blank connector

Create a new connector

1. If you select Start from a blank connector, you must set the:

   • Provider name
   • Application name
   • Display name

2. Click Create.

   
   

   

   
   

Configure your connector

1. In the Confirm import window, you can:

   • Change the Provider name, Application name, and Connector name

   • Modify the resources you want to use in your custom connector. All available resources are automatically selected; unselect the ones you wish to exclude.

     • Use the Search bar to look for a specific resource.

       
       

       

       
       
   • Click Create.
2. The Settings window is now displayed.

3. In the Info tab you can configure the following fields:

   • Connector prefix – for example, documentation. This is reflected in your connector key, for example, documentation-swaggerpetstore-swaggerpetstore
   • Provider name – Enter a provider name.
   • Application name – Enter an application name.
   • API type – This field is disabled by default, as only REST is currently supported.
   • Display name – This is the name of your connector, as it will appear in the Connector catalog.
   • Description – Enter a description for your connector.
   • Icon – Click Browse to upload an image from your computer.
4. Catalog preview displays how your custom connector will appear in the Integration Service connector catalog.

5. Click Save.

   
   

   

   
   

Configure the Base API

In the Base API tab, you configure the base URL for the application API and pagination:

• Base URL – Automatically filled with the value declared at connector creation.
• Pagination type – Options available in the drop-down are: Page start with 1, Page starts with 0, Offset, Custom. If the vendor documentation doesn’t provide any details on pagination, keep the default value.
• Pagination max – Default value is 100. If the vendor documentation doesn’t provide any details on pagination, keep the default value.
• Content-Type header – This field is disabled by default, as only application/json is currently supported.

• Accept header – This field is disabled by default, as only application/json is currently supported.

  
  

  

  
  

Set the authentication method

In the Authentication tab, you configure the authentication type for your connector. Supported options are:

• Basic

• OAuth 2.0:

  • Authorization Code
  • Authorization code with PKCE
  • Client Credentials
• API Key
• Personal Access Token (PAT)

• No Authentication

  Note: When configuring the authentication, you are configuring how anybody using your connector needs to authenticate. This will be you while you are building the connector, but could also be others that end up using your creation.

Basic authentication

1. Click the edit icon under the Action column to configure each property. Username and Password are available by default.

2. Click Add parameter if you want to add another field to be used during authentication:

   • Display name – Shown to the user when connecting.
   • Type – Defines the input field on the connection dialog. Select an option from the drop-down: true/false, password, test, yes/no.
   • Ask the user – Set to Yes when user input is required.
   • Value – Use this field to set a default value.
   • Hint text – User guidance for the input field.
   • Provider name - The technical key for the API call.

   • Send to provider as type – How the API receives the value. Select an option from the drop-down: configuration, header, path, body, query, form. Default value: header.

     
     

     

     
     
3. Click Save to save your new authentication parameter.
4. Use the Reset to default option if you want to reset your authentication to the original values for Basic. This operation cannot be undone.

OAuth 2.0 Authorization Code

To use OAuth 2.0 Authorization Code, you need to create an OAuth app in the application you want to integrate with, and retrieve from there the credentials necessary for configuring your connector.

Configure the following fields:

• Client ID
• Client secret
• Scope
• Authorization URL
• Token URL
• Refresh token URL
• Basic header
• Token revoke URL

• Refresh interval

  Note: The Authorization, Token, and Refresh token URLs should be available in the app's API documentation.
  
  

  

  
  

OAuth 2.0 Authorization Code with PKCE

OAuth 2.0 Authorization Code with PKCE is identical to the OAuth 2.0 Authorization Code method, but it also include the OAuth2 PKCE Code Challenge Method field.

OAuth 2.0 Client Credentials

For OAuth 2.0 Client Credentials, you must configure the following fields:

• Client ID
• Client secret
• Scope
• Token URL
• Basic header

• Refresh interval

  
  

  

  
  

API Key

Use this option for integrating with apps that require an API key to make API calls against.

Set the API Key field to your desired value.

Personal Access Token

Use this option for integrating with apps that require a bearer token to make API calls against.

Set the Personal Access Token field to your bearer token.

No authentication

Use this option if you don’t need users to authenticate to use the connector.

Test your connection

Once you have completed the authentication configuration, select Add connection from the drop-down menu:

If your connection is successful, the status is updated to Connected.

Resources

When you create a connector from scratch, you must add the resources you need.

1. Click Create new resource group to interact with the data objects.
2. Use the vendor API documentation to select the endpoints you want to add to your connector.
3. Choose the different methods you want to support on your connector to interact with the data in the application.
4. Add the Path and Display name. Display name represents the Object you will select when building automations using Studio activities.
5. Click Create.
6. For each resource created, you can then edit parameters, change the configuration, pagination, and enable search setup.

7. Use the Send Request button to test your API call.

   
   

   

   
   

Once you add all your resources, you can continue configuring them. See the Configure your connector section.

After you configure everything you need, you can continue with Publishing your connector.