Skip to main content

Client Registration API

Client Registration API Documentation

The Client Registration API documentation can be found at https://api.vegacloud.io/identity/clientregistration/docs#/.

Purpose

An API Client Registration allows your client application (such as a script or bot) to interact securely with Vega Platform APIs and services by registering it with the Vega Authentication System. This registration assigns a unique identity to your application, functioning like a digital badge that authenticates your application's requests to Vega services. Your application is secured via a Client Secret Key, a confidential key that verifies your application's identity when accessing Vega resources. Treat this Client Secret Key as a sensitive piece of information, ensuring that only your application has the access needed to communicate with Vega services securely.

Connecting to the Client Registration API

To ensure secure access to the API, we utilize JWT (JSON Web Token) authentication. The token is validated to verify the user's identity and permissions and must be included in the Authorization header of the HTTP request to access protected endpoints.

tip

Generate an API Client Registration to securely access the Client Registration API.