Custom API Settings

The Custom API connector acts as an All-In-One (AIO) as it allows you to interact with any APIClosed Application Programming Interface: a set of functions made available to interact and integrate with a software application or system..

As each API is different and thus requires specific settings, the interface of this connector is generic.

To define an API, you only need to upload the API Profile file (.apip extension) and/or Tables (.rsd files) and specify the properties (connection strings) by manually adding them through the Additional Connection Properties section.

Note

To customize an API profile, refer to Customizing your API or follow the procedure described below to use an API default profile and its related tables.

To set up a Custom API connection:

  1. In the Connection page, click New to create a new source connection.
  2. In the list, select Custom API.

  3. Fill out the fields in the New Connection dialog box as described in the tables below.

  4. Change the advanced settings (Tracking type, etc.) according to your preferences.

  5. Click Save.
Connection Properties Description
Description Enter a name for the source connection (preferably related to the API you want to connect to).
Authentication Type

Select the authentication method used by the API.

  • None: Select this option if you are connecting to a public Web API where no credentials are required to display / retrieve data from the URL.

  • HTTP (Basic):

  • OAuth2: When you select this option, three additional properties are displayed by default (OAuthClientId, OAuthClientSecret, and CallbackURL).
Verbosity

The verbosity level that determines the amount of detail included in the log file. Verbosity levels range from 1 to 5; the default is 3.
Proxy Server Select this option if you wish to enable the proxy server.
API Profile

  1. Click Upload to browse to the location where the API profiles are stored.

  2. Select an API profile.

  3. Click Open.

 

Additional connection Properties Description
ProfileSettings

A semicolon-separated list of name-value pairs required by your chosen data source. It is used only for the HTTP (Basic) authentication type.

  • Format: Key1=Value1;Key2=Value2

  • Values: User, Password, Domain

  • Connection string: ProfileSettings='User=EmailId;Password=key';'Other=Domain=YourDomain'
Other

In most cases, this is used with all API providers and is similar to the ProfileSettings property. It can be used for None, HTTP Basic or OAuth2 authentication types.

  • Format: Key1=Value1;Key2=Value2

  • Values:

    • DefaultColumnSize: Sets the default length of string fields when the Data Source does not provide column length in the metadata. The default value is 2000.

    • ConvertDateTimeToGMT: Determines whether to convert date-time values to GMT, instead of the local time of the machine.

    • RecordToFile: Records the underlying socket data transfer to the specified file.

  • Connection string:

    DefaultColumnSize=numeric value

    ConvertDateTimeToGMT=true

    RecordToFile=file name

CallbackURL

The URL to return to when authenticating with OAuth2. This value must match the callback URL you specify in your app settings.

  • Value: URL address

  • Connection string: CallBack URL=Full URL Address
OAuthClientId

The Client ID assigned when you register your application with an OAuth authorization server.

  • Connection string: OAuthClientId=Unique Identifier key
OAuthClientSecret

The Client Secret assigned when you register your application with an OAuth authorization server.

  • Connection string: OAuthClientSecret=password
Scope

Defines the specific actions applications can be allowed to do on a user's behalf. It is used with the OAuth2 authentication type.

  • Value: Forms

  • Connection string: Forms=Read