> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cloud.cdata.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Global Settings
## Summary
Global settings apply to all the tables that can be discovered through an API connection. This page covers the configuration of authentication, headers, and pagination. Once these are set, you can continue to the **Tables** tab and create [Tables](/en/Data-Sources/APICreateTable).
## Connection Type
You can select a **Direct** or a **Connect Gateway** connection. If you select **Direct**, continue to **Authentication**. If you are setting up a Connect Gateway on-premises connection, see [Connect Gateway](/en/Connect-Gateway) for more information.
## Authentication
By default, an API connector is set to **No Auth**. If your API requires authentication, select the appropriate method and follow the instructions in the relevant tab below. If no authentication is required, click **Save Changes** to save the connector. Afterwards, configure any required Headers and the Pagination type before creating tables.
The authentication method you choose applies to every table added to this connector.
No additional settings are required for this authentication method.
At the top of the Connect AI **Add API Connection** page, click **Save Changes** to save the connection.
After saving the connection, click **Tables** to move on to creating [Tables](/en/Data-Sources/APICreateTable).
In the **User** field, enter the API username for authentication.
Enter the user password in the **Password** field.
At the top of the Connect AI **Add API Connection** page, click **Save Changes** to save the connection.
After saving the connection, click **Tables** to move on to creating [Tables](/en/Data-Sources/APICreateTable).
In the **User** field, enter the API username for authentication.
Enter the user password in the **Password** field.
At the top of the Connect AI **Add API Connection** page, click **Save Changes** to save the connection.
After saving the connection, click **Tables** to move on to creating [Tables](/en/Data-Sources/APICreateTable).
The **Callback URL**, or Redirect URL, is the URL you need (`https://oauth.cdata.com/oauth/`) when setting up your OAuth app. Copy this URL and paste it into your OAuth app.
Enter the **OAuth Client Id** assigned when you registered for OAuth with your API service.
Enter the **OAuth Client Secret** assigned when you registered for OAuth with your API service.
Enter your **OAuth Request Token URL** to retrieve request tokens from.
Enter your **OAuth Authorization URL** so request tokens can be authorized on sign in.
Enter your **OAuth Access Token URL** so authorized request tokens can be exchanged for access tokens.
Click **Sign in** to connect securely through OAuth. This action opens the API provider's sign-in page in a new tab.
Log in to your API provider and provide the requested permissions (if applicable).
At the top of the Connect AI **Add API Connection** page, click **Save Changes** to save the connection.
After saving the connection, click **Tables** to move on to creating [Tables](/en/Data-Sources/APICreateTable).
The **Callback URL**, or Redirect URL, is the URL you need (`https://oauth.cdata.com/oauth/`) when setting up your OAuth app. Copy this URL and paste it into your OAuth app.
Enter the **OAuth Client Id** assigned when you registered for OAuth with your API service.
Enter the **OAuth Client Secret** assigned when you registered for OAuth with your API service.
Enter your **OAuth Authorization URL** so users can be authorized on sign in.
Enter your **OAuth Access Token URL** so authorization tokens can be exchanged for access tokens.
Enter your **OAuth Refresh Token URL** so refresh tokens can be exchanged for access tokens when old access tokens expire.
Select the **OAuth Client Authentication Mode**: **Send as Basic Auth header** or **Send in Post body**. Select the authentication mode that the API provider's documentation recommends. The default value is **Send as Basic Auth header**.
Enter the **Header Prefix**. The header prefix is incorporated into the Authorization header before the token. The default value is `Bearer`.
Click **Sign in** to connect securely through OAuth. This action opens the API provider's sign-in page in a new tab.
Log in to your API provider and provide the requested permissions (if applicable).
At the top of the Connect AI **Add API Connection** page, click **Save Changes** to save the connection.
After saving the connection, click **Tables** to move on to creating [Tables](/en/Data-Sources/APICreateTable).
#### OAuth 2.0 Custom Parameters
To add custom parameters to associated requests in OAuth 2.0, do the following:
Enter the parameter name in the **Name** field.
Enter the value of the parameter in the **Value** field.
To add more parameters, click **Add Parameter** and repeat the above steps as required.
Enter the **OAuth Client Id** assigned when you registered for OAuth with your API service.
Enter the **OAuth Client Secret** assigned when you registered for OAuth with your API service.
Enter your **OAuth Access Token URL** so authorization tokens can be exchanged for access tokens.
(Optional) Enter **OAuth Scopes**. These scopes tell the access token what it is permitted to do. Check your API provider's documentation for the scopes it supports.
Select the **OAuth Client Authentication Mode**: **Send as Basic Auth header** or **Send in Post body**. Select the authentication mode that the API provider's documentation recommends. The default value is **Send as Basic Auth header**.
Enter the **Header Prefix**. The header prefix is incorporated into the Authorization header before the token. The default value is `Bearer`.
At the top of the Connect AI **Add API Connection** page, click **Save Changes** to save the connection.
After saving the connection, click **Tables** to move on to creating [Tables](/en/Data-Sources/APICreateTable).
#### OAuth Client Custom Parameters
To add custom parameters to OAuth Client token requests, do the following:
Enter the parameter name in the **Name** field.
Enter the value of the parameter in the **Value** field.
In the **User** field, enter the API username for authentication.
Enter the user password in the **Password** field.
Enter the **OAuth Client Id** assigned when you registered for OAuth with your API service.
Enter the **OAuth Client Secret** assigned when you registered for OAuth with your API service.
Enter your **OAuth Access Token URL** so authorization tokens can be exchanged for access tokens.
(Optional) Enter **OAuth Scopes**. These scopes tell the access token what it is permitted to do. Check your API provider's documentation for the scopes it supports.
Select the **OAuth Client Authentication Mode**: **Send as Basic Auth header** or **Send in Post body**. Select the authentication mode that the API provider's documentation recommends. The default value is **Send as Basic Auth header**.
Enter the **Header Prefix**. The header prefix is incorporated into the Authorization header before the token. The default value is `Bearer`.
At the top of the Connect AI **Add API Connection** page, click **Save Changes** to save the connection.
After saving the connection, click **Tables** to move on to creating [Tables](/en/Data-Sources/APICreateTable).
#### OAuth Password Custom Parameters
To add custom parameters to associated requests in OAuth Password, do the following:
Enter the parameter name in the **Name** field.
Enter the value of the parameter in the **Value** field.
Enter the **Bearer Token** obtained from your API provider. The bearer token can be obtained from the provider's developer portal, from a command-line tool, or through other means. Refer to your provider's documentation.
At the top of the Connect AI **Add API Connection** page, click **Save Changes** to save the connection.
After saving the connection, click **Tables** to move on to creating [Tables](/en/Data-Sources/APICreateTable).
Select the **API Key Type**: **Header** or **Query Parameter**. The key type depends on the API provider. See the provider's API reference for details.
Enter the **API Key Name**. This is the name of the key that you created in your API provider (usually in the provider's developer portal).
Enter the **API Key Value**. This value is the key itself; keep it confidential.
At the top of the Connect AI **Add API Connection** page, click **Save Changes** to save the connection.
After saving the connection, click **Tables** to move on to creating [Tables](/en/Data-Sources/APICreateTable).
## Headers
To add HTTP headers that are sent with all API calls, do the following:
Enter the header name in the **Name** field.
Specify the value of the header in the **Value** field.
To add more headers, click **Add Header** and repeat the above steps as required.
## Pagination
You can specify the pagination **Type** to use with the API Connector. First, select the Pagination type. The options available are:
### None
Any API request returns the full dataset in one response.
### Offset
When using offset paging, Connect AI defines the page size and the number of records to skip when retrieving subsequent pages. For offset paging, set the following values:
* **Offset Param**: The name of the URL parameter defining the API offset in the API request.
* **Page Size Param** (Optional): The name of the URL parameter defining how many records to retrieve per page.
* **Page Size**: The number of records to retrieve per page. The connector uses this value to calculate the offset. Set this to the default page size of the API you are connecting to.
#### Example
In the request below, the user has set **Offset Param** to "pageOffset", **Page Size Param** to "pageSize", and **Page Size** to 1000. This example is showing the request for page 6 of data because the connector automatically increments the offset.
```bash theme={null}
https://myapi?pageOffset=5000&pageSize=1000
```
### Number
When using page numbers to control paging, set the following values:
* **Page Number Param**: The name of the URL parameter defining the page number.
* **Page Size Param** (Optional): The name of the URL parameter that defines the page size.
* **Page Size** (Optional): The number of records to retrieve per page.
#### Example
In the request below, the user has set **Page Number Param** to "pageNum", **Page Size Param** to "pageSize", and **Page Size** to 1000. This example is showing the request for page 6 of data because the connector automatically increments the page.
```bash theme={null}
https://myapi?pageNum=6&pageSize=1000
```
### Token
When using next page token to control paging, set the following values. The connector automatically includes the token in each request from the previous response.
* **Token Path**: The path in the API response defining the next page token.
* **Has More Path** (Optional): The path in the API response defining whether there are more records available.
* **Token Source**: Select whether the token should be sent in the request as a `URL Parameter` or in the `Request Body`.
* **URL Parameter**: The name of the URL parameter to pass the paging token.
* **Request Body**: The path in the request body where to pass the paging token.
#### Example using Parameters
In the request below, the user has set **URL Parameter** to “pageToken” and **Token Path** to “/results/nextpagetoken”.
**Request:**
```bash theme={null}
https://myapi?pageToken=123456
```
**Response:**
```json theme={null}
{
"results": [
{
"rows": [
{
"id": "123",
"name": "Acme",
"country": "United States",
"no_employees": 500
},
...
],
"nextpagetoken": 123457
}
]
}
```
#### Example using Body
In the request below, the user has set **Request Body** to “/request/pageToken”, **Token Path** to “/results/nextpagetoken”, and **Has More Path** to “/results/morePages”.
**Request Body:**
```json theme={null}
{
"request": [
{
"country": "United States",
"pageToken": 123456
}
]
}
```
**Response:**
```json theme={null}
{
"results": [
{
"rows": [
{
"id": "123",
"name": "Acme",
"country": "United States",
"no_employees": 500
},
...
],
"nextpagetoken": 123457,
"morePages": true
}
]
}
```
### URL
When using next page URLs to control paging, you first need to select where the URL for the next page is in the response:
* **Response Type**: Select either `Response Body` if the URL is in the body of the response, or `Response Header` if the URL is in a header of the response.
* **Response Body**: The path in the API response defining the next page URL. This value should be supplied in XPath notation. See the example below.
* **Response Header**: If the next page URL is passed in the response headers with a “Link” header, set this to specify the header name.
#### Example using Path
In the example below, the user has set **Response Body** to “/results/nextpageurl”. Here is an example response which contains the next page URL:
**Response:**
```json theme={null}
{
"results": [
{
"rows": [
{
"id": "123",
"name": "Acme",
"country": "United States",
"no_employees": 500
},
...
],
"nextpageurl": "https://myapi?nextpage=81a3ebdb-1483-45cd-84d1-f711d1308698"
}
]
}
```
## Advanced
The **Verbosity** field should be left at `2` unless required for troubleshooting purposes.
After creating an API connection, proceed to creating [Tables](/en/Data-Sources/APICreateTable).
You can add **Retry Status Codes** to retry the request if the API call fails with that status code.