API#

The API screen has three tabs:

  1. Swagger
    This subsection opens the interactive API documentation. The user can view available requests, their parameters, the response structure, and use Swagger as a reference for checking integrations.
    The documentation is also available at: https://orchestrator.sherparpa.ru/api/docs/swagger.
  2. ReDoc
    This subsection opens an alternative view of the API documentation.
    ReDoc is convenient for reading: it makes it easier to browse method descriptions, data schemas, and required request fields.
  3. Key
    This subsection is where the user manages the API key.
    Here you can view the current key, copy it, or generate a new one. This key is used to authorize external systems when accessing the Sherpa Orchestrator API.