Custom API Source Connector

The Custom API source connector in DataSync lets you connect to any REST API to extract and integrate data. To set up the connection, upload an API Profile file (.apip), table definitions (.rsd files), or both, and then fill in the required connection properties.

Once your source connection is ready, set up your destination connection to complete the configuration.

note

You need to create your API profile files (.apip or .rsd) before you configure a Custom API source connection. For more information, see Understand API Profile Structure, and Build a Custom API Profile.

Create a custom API source connection in DataSync

1. Log in to DataSync.
2. From the welcome screen, select Connections.
3. Next to Source Connections, click New.
4. Select Custom API.
5. In the Connection Properties panel, enter the connection properties.
6. (Optional) In the Additional Connection Properties panel, select Add property and enter the parameters for each property.
7. In the Advanced Settings panel, configure the settings, including Tracking Type and any other values according your setup requires.
8. Click Save.

Parameters

Connection properties

Parameter	Description
Description	Unique name for this API connection. For example: Custom API
Authentication Type	Authentication method your API uses. Choose one of the following options: None – for a public API that requires no authentication. HTTP (Basic) – for basic HTTP authentication, which uses values you provide in ProfileSettings. OAuth2 – for OAuth2 authentication, which supports the authorization code method (requires a CallbackURL) or the client credentials method (no callback required).
Verbosity	Controls how much detail the connector writes to the log. Higher levels include everything from the level below, plus additional detail: 1 – Queries, row counts, execution start and end, errors. 2 – Everything in level 1, plus cache queries and HTTP headers. 3 – Everything in level 2, plus request and response bodies. 4 – Everything in level 3, plus transport-level communication. 5 – Everything in level 4, plus all interface commands.
API Profile	Upload location for the API profile or table definition files. If you are using the client credentials method, see OAuth2 client credentials example.

HTTPS (Basic) additional connection properties

Property	Value
Other	Name-value pairs for additional provider options. Common examples: DefaultColumnSize=number – Sets the default string length when the API metadata does not specify one (default is 2000). ConvertDateTimeToGMT=true – Converts date-time values to GMT instead of local time. RecordToFile=file name – Logs socket data transfers to the file you specify.
ProfileSettings	The settings your data source requires, entered as a list separated by commas. For example: ProfileSettings='User=EmailId;Password=key';'Other=Domain=YourDomain'.

OAuth2 (authorization code) additional connection properties

Use this method when a user signs in through a browser and the authorization server redirects them back to your callback URL.

Property	Value
Other	Name-value pairs for additional provider options. Common examples: DefaultColumnSize=number – Sets the default string length when the API metadata does not specify one (default is 2000). ConvertDateTimeToGMT=true – Converts date-time values to GMT instead of local time. RecordToFile=file name – Logs socket data transfers to the file you specify.
CallbackURL	Redirect URL for OAuth2. This value must match the callback URL configured in your OAuth app settings. For example: https://.../OAuthCallback/CallbackUrl/....
OAuthClientId	CLient identifier assigned by your OAuth2 authorization server. For example: OAuthClientId=Unique Identifier key.
OAuthClientSecret	Secret value assigned by your OAuth2 authorization server. Set the storage type to Encrypted. For example: OAuthClientSecret=password.
Scope	Permission scope for your application. For example: Forms=Read.

OAuth2 (client credentials) additional connection properties

Use this method for system-to-system connections where no user sign-in is required and no callback URL is needed.

Property	Value
Other	Enter OAuthIncludedCallbackURL=False.
AuthScheme	Enter OAuth.
OAuthClientId	Client identifier assigned by your OAuth2 authorization server.
OAuthClientSecret	Secret value assigned by your OAuth2 authorization server. Set the storage type to Encrypted.
Scope	Enter the provider-specific scope. For example: employees.readonly.
InitiateOAuth	Enter GETANDREFRESH.

Advanced settings

Advanced settings control how the Custom API connector tracks changes, handles time and regional configuration, and processes records during extraction. You should configure them to match your system environment for accurate and consistent results.

Setting	Description
Tracking Type	Method the connector uses to track changes. Select None or Date.
Region	Region for this connector, if your setup requires one.
Time Zone	Time zone of your Custom API application server. This value must match the time zone set in the API profile. A mismatch causes data to sync at the wrong time or return incorrect records.
Time Offset	Offset in seconds that compensates for timing differences during record selection. The minimum value is 0 and the maximum is 3600 seconds.
Batch Size	Number of records the connector processes per batch during extraction. A larger batch size uses more memory but can improve performance. The default is 2000 records and the maximum is 10000. In most cases, the default works well. Adjust this value based on your network speed and available disk performance.