The Make API Call step enables you to integrate external APIs into your data pipelines. You can configure API sources, define endpoints, and map input and output parameters to create seamless data exchanges with external systems.
What is API Call?
The API Call feature allows you to connect to external APIs and incorporate them into your data pipelines. This enables you to:
- Retrieve data from external systems
- Send data to external APIs
- Transform and map data between your pipeline and external services
- Automate data exchanges with third-party applications
Key concepts
- API Source
- A configured connection to an external API, including authentication details and base URL information.
- API Endpoint
- A specific operation or resource within an API source that you want to call.
- Open API Specification
- A standardized format for describing REST APIs. You can provide this as a URL or upload a file.
- Input Configuration
- The parameters and data you send to the API endpoint.
- Output Configuration
- The response data returned from the API endpoint that you want to use in your pipeline.
User permissions
There are two types of users who can work with API Call. Users with permission to manage APIs can create, edit, and delete API sources and endpoints. Users with permission to view APIs can only view and select from existing API sources and endpoints.
| Allowed to | User permission | |
|---|---|---|
| Manage APIs | View APIs | |
| View all available API sources and endpoints. | Yes | Yes |
| Create new API sources | Yes | No |
| Add new endpoints to existing API sources | Yes | No |
| Edit API source and endpoint configurations | Yes | No |
| Delete API sources and endpoints | Yes | No |
| Select any API source or endpoint for use in pipelines. | Yes | Yes |
| Configure input and output parameters when using an API in a pipeline | Yes | Yes |
Contact your workspace administrator to request the appropriate permissions.