Ru

API#

На экране API доступны три вкладки:

  1. Swagger
    В этом подразделе открывается интерактивная документация API. Пользователь может посмотреть доступные запросы, их параметры, структуру ответа и использовать Swagger как справочник для проверки интеграций.
    Документация также доступна по ссылке: https://orchestrator.sherparpa.ru/api/docs/swagger.
  2. ReDoc
    В этом подразделе открывается альтернативное представление API-документации.
    ReDoc удобен для чтения: в нём проще просматривать описание методов, схемы данных и обязательные поля запросов.
  3. Key
    В этом подразделе пользователь работает с API-ключом.
    Здесь можно посмотреть текущий ключ, скопировать его или сгенерировать новый. Этот ключ используется для авторизации внешних систем при обращении к API Sherpa Orchestrator.