Методы API могут быть вызваны любым инструментом, делающим запросы по протоколу HTTP (например: cURL, GNU Wget, Postman).

Справа от маршрута метода указано краткое описание.

Способ вызова метода GET или POST указан слева от маршрута.

В фигурных скобках указаны обязательные параметры, передаваемые в URL при вызове метода.

Более подробное описание метода, всех параметров и типов данных содержится в детальной информации, вызываемой кликом по названию метода.

Например, детальное описание метода:

GET /api/v1/tender/

Содержит следующую информацию:

  1. Детали реализации (в случае необходимости пояснения работы метода):



  2. Параметры, передаваемые в URL, строке или в теле запроса:



    Отдельно отмечаются:

    • Required - обязательные параметры;
    • Parameter Type –тип передачи параметра:
      • Path – параметр встраивает в URL запроса;
      • Query – параметр указывается в «строке поиска»;
      • Body – данные передаются в теле запроса (для POST запросов).
    Пример передаваемых в теле данных.

    Например:



  3. Описание и пример возвращаемых данных в случае удачного исполнения:



  4. Коды ошибок (HTTP Status Code) и их расшифровку в случае неудачного исполнения: