Consume API endpoints

The consumption of API endpoints is an addition to the default IDS interaction that allows to exchange API endpoints. This allows for existing HTTP services to work over IDS. For this the OpenAPI Data App is used.

The process of consuming an API is as follows:

1. retrieve metadata of the connector and OpenAPI data app resources,
2. send the HTTP request to the OpenAPI data app connected to your own connector

The test connector deployed at https://test-connector.playground.dataspac.es/ui/ provides an agent that exposes an test server implementing the https://httpbin.org/ API specification.

The following deployment strategies can be chosen for consuming API endpoints:

• Local Kubernetes: For Kubernetes clusters on local hardware, e.g. via Docker Desktop, Minikube, MicroK8s.
• Public Kubernetes: For Kubernetes clusters on cloud infrastructure or on self-managed servers that are reachable from the internet.
• Docker Compose: If you don’t have any experience with Kubernetes and no intention to use it in the future. Configuration will be harder for Docker deployments, especially when moving towards a publicly available connector.