Rest API
In this doc, we will cover how to setup a Connection to a Rest API endpoint.
Prerequisites
- Rest API Endpoint
- Response pagination information
- Response data field name (if needed)
- Credentials (if needed)
Create New Rest API Connection
![Screen Shot 2022-09-02 at 11.28.30 AM.png 3446](https://files.readme.io/f0fb53b-Screen_Shot_2022-09-02_at_11.28.30_AM.png)
Figure 1
![Screen Shot 2022-09-02 at 11.30.44 AM.png 1206](https://files.readme.io/7779853-Screen_Shot_2022-09-02_at_11.30.44_AM.png)
Figure 2
- ACCESS TYPE: Select whether this connection can be used for both Read and Write Connectors. This connection only supports reading.
- CONNECTION NAME: The name to identify the connection.
- BASE URL: URL of the endpoint.
- RESPONSE DATA FIELD NAME: Field name that contains the data. Leave blank if you'd like to ingest the whole response object.
- PAGINATION TYPE: Pagination type of the response: No Pagination, Offset and Limit, or Next Token.
- REQUIRES CREDENTIALS: If de-selected, only the publicly accessible datasets can be accessed.
Create New Credentials
![Screen Shot 2022-09-02 at 12.03.19 PM.png 1374](https://files.readme.io/3e52fc6-Screen_Shot_2022-09-02_at_12.03.19_PM.png)
Figure 3
- CREDENTIAL NAME: The name to identify the credential.
- CREDENTIAL TYPE: REST API.
- AUTHORIZATION TYPE: Type of authorization: Query Parameter or Authorization Header.
- VALUE: Credential value.
Updated almost 2 years ago