Обучение rest api
Учебный центр R-Service
Прогресс прохождения курса
44%
Упражнение 4. ТЕСТИРОВАНИЕ КОНЕЧНОЙ ТОЧКИ
Прежде чем создавать свой первый вызов REST API, убедитесь, что вы можете достичь конечной точки демонстрационной среды R-Service с помощью CURL или любого другого инструмента разработчика, который вы используете. Вам не нужно включать заголовок для токена личного доступа или указывать учетную запись для тестирования конечной точки.
Команда CURL: curl -i "https://api.demo.rrtsm.ru/v1".
Когда вы выполняете этот вызов REST API, вы должны получить HTTP 200 OK ответ, состоящий из 2 символов {}.
Когда вы выполняете этот вызов REST API, вы должны получить HTTP 200 OK ответ, состоящий из 2 символов {}.
Обработка ошибок REST API
В предыдущем упражнении вы получили ответ с кодом HTTP 200 OK. При создании интеграций на основе REST API важно всегда проверять HTTP-коды состояния в ответ на запросы. Для успешного выполнения запроса, например HTTP POST, должен возвращаться код 200 OK (Success).
Если вы получаете код состояния, отличный от 200, это может указывать на одну из следующих проблем:
Ограничение скорости REST API
Один из ключевых кодов состояния — 429 Too Many Requests (Превышен лимит запросов). Все поставщики облачных API вводят ограничения на количество запросов для защиты и оптимального распределения ресурсов.
В случае получения кода 429 ваша интеграция должна обрабатывать это, проверяя заголовок Retry-After, который указывает, сколько секунд необходимо подождать перед повторной отправкой запроса. Подробности можно найти в руководстве разработчиков R-Service.
Синтаксис команды CURL
После создания персонального токена доступа для Гаврюковой Елизаветы вы готовы приступить к упражнениям. Вот пример полной команды REST API с использованием CURL.
Вы можете включить два обязательных заголовка с помощью опции -H в CURL:
curl -X <HTTP Verb> -i -H "Authorization: Bearer <personal-token>" -H "X-4me-Account: <accountID>" "https://api.demo.rrtsm.ru/v1/<path>"
При копировании команды из этого примера не забудьте заменить <personal-token> на фактический персональный токен доступа Гаврюковой Елизаветы.
Опция -i в CURL выводит дополнительную информацию, такую как заголовки ответов.
В предыдущем упражнении вы получили ответ с кодом HTTP 200 OK. При создании интеграций на основе REST API важно всегда проверять HTTP-коды состояния в ответ на запросы. Для успешного выполнения запроса, например HTTP POST, должен возвращаться код 200 OK (Success).
Если вы получаете код состояния, отличный от 200, это может указывать на одну из следующих проблем:
- Проблемы на стороне сервера (коды 5xx HTTP, коды 1xxx WebSocket)
- Проблемы на стороне клиента, такие как ограничение скорости или несанкционированный доступ (коды 4xx HTTP).
Ограничение скорости REST API
Один из ключевых кодов состояния — 429 Too Many Requests (Превышен лимит запросов). Все поставщики облачных API вводят ограничения на количество запросов для защиты и оптимального распределения ресурсов.
В случае получения кода 429 ваша интеграция должна обрабатывать это, проверяя заголовок Retry-After, который указывает, сколько секунд необходимо подождать перед повторной отправкой запроса. Подробности можно найти в руководстве разработчиков R-Service.
Синтаксис команды CURL
После создания персонального токена доступа для Гаврюковой Елизаветы вы готовы приступить к упражнениям. Вот пример полной команды REST API с использованием CURL.
Вы можете включить два обязательных заголовка с помощью опции -H в CURL:
curl -X <HTTP Verb> -i -H "Authorization: Bearer <personal-token>" -H "X-4me-Account: <accountID>" "https://api.demo.rrtsm.ru/v1/<path>"
При копировании команды из этого примера не забудьте заменить <personal-token> на фактический персональный токен доступа Гаврюковой Елизаветы.
Опция -i в CURL выводит дополнительную информацию, такую как заголовки ответов.
Телефон
+7 (495) 231-73-64
E-mail
office@rr-th.com
Адрес
Москва, Цветной бульвар д. 26, стр. 1, офис 36
© 2024 ООО "РР-ТЕХ"
Разработка российского программного обеспечения
Свяжитесь с нами
Оставьте контакты и мы ответим на Ваши вопросы