isaak.io
Search…
Запросы к API

Основная информация о запросах

Запрос — это обращение одного сервиса к другому для получения или отправки информации.
Запросы можно делать к любому стороннему сервису, который их поддерживает. Как правило, вы можете найти документацию к API в публичном доступе. Если этого сделать не удалось — свяжитесь с поддержкой или разработчиком нужной системы.
Isaak умеет отправлять запросы и принимать ответы в различных форматах: JSON, formdata (пары ключ/значение) или любой текстовый формат, включая xml.
Существует множество типов запросов, мы используем самые распространенные: GET, POST, PUT и DELETE.
  • GET чаще всего применяется как запрос получения информации. В некоторых случаях может использоваться равнозначно с другими типами. Например, в Telegram можно использовать и GET, и POST для одинаковых запросов.
  • POST применяется для отправки информации и создания объектов. С помощью этого метода чаще всего формируются заказы, создаются заявки и т.д.
  • PUT обновляет информацию об объекте.
  • DELETE удаляет созданный объект.

Основная информация об ответах

Ответом на запрос может быть информация об ошибке или удачном запросе с дополнительными данными или без них.
Если запрос прошел успешно, код будет иметь значение, начинающееся на 2:
  • 200 OK — успешный запрос.
  • 201 Created — в результате успешного выполнения запроса был создан новый ресурс.
  • 202 Accepted — результат был принят в обработку, но она не завершена.
Если запрос не прошел из-за ошибки параметров запроса, код ошибки будет иметь значение, начинающееся на 4:
  • 400 Bad Request — сервер обнаружил в запросе клиента синтаксическую ошибку.
  • 401 Unauthorized — для доступа к запрашиваемому ресурсу требуется аутентификация.
  • 403 Forbidden — сервер понял запрос, но он отказывается его выполнять из-за ограничений в доступе для клиента к указанному ресурсу.
  • 404 Not Found — запрашиваемый ресурс не был найден или не существует.
Если запрос не прошел из-за ошибки сервера, код ошибки будет иметь значение, начинающееся на 5:
  • 500 Internal Server Error — любая внутренняя ошибка сервера.
  • 501 Not Implemented — сервер не может обработать запрос.
  • 502 Bad Gateway — сервер, выступая в роли шлюза или прокси-сервера, получил недействительное ответное сообщение от вышестоящего сервера.
  • 503 Service Unavailable — сервер временно не имеет возможности обрабатывать запросы по техническим причинам.
  • 504 Gateaway Timeout — сервер в роли шлюза или прокси-сервера не дождался ответа от вышестоящего сервера для завершения текущего запроса.