Перейти к содержанию

Использование API

По умолчанию в API Orgstack используются POST-запросы. Тем не менее, для методов API, заканчивающихся на list, вы можете применять и GET-запросы.

Отправка запросов

Запросы можно отправлять двумя способами:

  • Используя url https://app.orgstack.ru

    https://app.orgstack.ru/api/profile/save?project={project_host}&key=123456
    
  • Используя адрес вашего проекта

    https://{project_host}.orgstack.ru/api/profile/save?key=123456
    

где project_host — хост вашего проекта в Orgstack.

Примеры

Пример отправки запроса с использованием утилиты curl:

curl 'https://{project_host}.orgstack.ru/{route_url}' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: 123456' \
    --data '{"field":value}'

В документации каждого апи метода вы можете посмотреть пример отправки запроса во вкладке Пример запроса.

Обработка ошибок

В случае возникновения ошибки сервер отдает ответ в следующем формате:

{
  "status": "error",
  "error": "error_name",
  "error_message": "message"
}

Список возможных ошибок:

Имя Описание
not_found Запрашиваемая сущность не найдена.
already_exists Сущность с заданными параметрами уже существует.
permission_denied Отказ в разрешении на выполнение операции.
wrong_request Запрос с указанными параметрами не может быть выполнен.
invalid_request Ошибка в параметрах запроса.
internal_error Внутренняя ошибка. При ее возникновении рекомендуем вам сообщить о ней в сервис поддержки.

Ограничения

На вызовы api установлены следующие квоты:

  • до 10 запросов в секунду
  • до 100 запросов в минуту