Connector APIs

The Connector consists of several software components. Each of these expose several APIs. Please refer to other parts of this documentation, for more information on the components in general.

Controlplane

Management API

The Management API lets you manage all your Assets, Policy Definitions, etc. It is available at /connectors/<connector-name>/management and all of its endpoints are protected. For detailled documentation on this API, see Tractus-X EDC control-plane API. Note that the section "Application Observability" in the Tractus-X EDC documentation is not part of the Management API but part of the Default API instead.

DSP API

The DSP API enables communication between Connectors and only meant to be used directly by Connectors themselves. It is available at /connectors/<connector-name>/dsp. For detailled documentation on this API, see EDC dsp-api.

Default API

The Default API exposes endpoints for checking health, readiness and simlar status indicators. It is available at /connectors/<connector-name>/default. For detailled documentation on this API, see Tractus-X EDC control-plane API, specifically the "Application Observability" section.

Dataplane

Public API

The Public API is used to perform PULL transfers and consists of only a single endpoint. It is available at /connectors/<connector-name>/public. For an example on how to utilize this API, see Tractus-X EDC Walkthrough.

Proxy API

The Proxy API can also alternatively be used for PULL transfers. It is available at /connectors/<connector-name>/proxy and all of its endpoints are protected. For an example on how to utilize this API, see Tractus-X EDC Walkthrough.

Identity Hub

Identity API

The Identity API is used to manage your DID documents, Verifiably Credentials, etc. It is available at /connectors/<connector-name>/ih/identity and all of its endpoints are protected. For detailled documentation on this API, see IdentityHub identity-api.

Presentation API

The Presentation API allows clients to request credentials in the form of a Verifiable Presentation. It is available at /connectors/<connector-name>/ih/presentation. For detailled documentation on this API, see IdentityHub presentation-api.

STS API

The STS API is responsible for generating ID-Tokens to access the Presentation API. It is available at /connectors/<connector-name>/ih/sts and all of its endpoints are protected. As it is only supposed to be used internally, this documentation will not provide a detailled description.

DID Document

The DID Document can of a Connector viewed by sending a GET request to /connector/<connector-name>/did.json.

Vault Token

The vault token to access the Hashicorp Vault at vault.adsel.space can be retrieved by making a GET request to /connectors/<connector-name>/vault/token. The vault can be used to provide the Connector with confidential information thourgh there rather than sending them directly in requests to the Connector.