Как ориентироваться в Swagger?

Все методы API (публичного и внутреннего) доступны в Swagger по ссылке следующего вида:

https://yourinstance.case.one/swagger/index.html

Чтобы начать работу с публичным API:

  1. Откройте Case.one и авторизуйтесь со своим логином и паролем для просмотра параметров сущности (например, идентификатор дела).
  2. Измените адрес в строке браузера, подставив swagger после имени домена инстанса Case.one, например: https://yourinstance.case.one/swagger/index.html. Откроется страница с описанием API.
  3. Выберите версию API в поле Select a definition. Отобразится API выбранной версии:
    • Для версии публичного API в заголовке будет указано Public API version X.0, для внутреннего — Internal API version XX.0, где X — номер версии
    • После заголовка отображается список методов API, сгруппированных по типу сущности
    • Рядом с названием группы методов приведено общее описание

Для внутреннего API поддерживаются только две версии:

  • Версия текущего релиза.
  • Версия предыдущего релиза.

Чтобы выбрать конкретный метод:

  1. Выберите группу методов и нажмите кнопку .
  2. Выберите метод и нажмите кнопку . Раскроется подробная информация о методе:
    • Описание конкретного метода
    • Описание необходимых заголовков
    • Описание входных параметров с типами
    • Описание возможных вариантов результата