API Data Provider - Online Help

Connecting to AirCall

To authenticate to AirCall, you can use either Basic authentication or the OAuth standard. Use Basic to connect to your own data. In order to allow other users to access their data, use OAuth authentication.

Using Basic Authentication

To authenticate to Aircall via Basic authentication, you'll need to specify your API Key and API ID. You can find your API Key and ID under your company's setting in 'Add a new API Key'. Set the User connection property to your API ID and the Password connection property to your API Token.

Example connection string

Profile=C:\profiles\AirCall.apip;User=my_api_id;Password=my_api_token;

Using OAuth Authentication

You will first need to register an OAuth app with Aircall. To create an Aircall app, sign up at the following link: https://aircall.io/partners/registration/. You also need to provide the Redirect URL that will be associated with your app.

After setting the following in your connection string, you are ready to connect:

  • AuthScheme: Set this to OAuth.
  • OAuthClientId: Set this to the client_id that AirCall has sent to you.
  • OAuthClientSecret: Set this to the client_secret that has sent to you.
  • CallbackURL: Set this to the Redirect URL you specified when applied for an app with AirCall.
  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.

Example connection string

Profile=C:\profiles\AirCall.apip;Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.


Property Description
AuthScheme The scheme used for authentication. Accepted entries are Basic or OAuth.
Allowed values are: BASIC, NONE, NTLM, OAUTH, OAUTH_CLIENT, APIKEY
CallbackURL The URL users return to after authenticating to API via OAuth.
InitiateOAuth Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.
Allowed values are: OFF, GETANDREFRESH, REFRESH
OAuthClientId Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server.
Password Specifies the password of the authenticating user account.
User Specifies the user ID of the authenticating API user account.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 24.0.9300.0