Ключ API — это простейшие учетные данные, которые может выдать API: длинная случайная строка, привязанная к учетной записи или проекту, отправляемая с каждым запросом — обычно в заголовке, например, X-API-Key, иногда в строке запроса. Он идентифицирует того, кто обращается к API, для целей выставления счетов, квот и контроля доступа, но не имеет собственного срока действия или области действия, если сервер их не добавит.
Сервер проверяет ключ при каждом запросе, отклоняет неизвестные запросы с кодом 401 и применяет квоту и права доступа, установленные для этого ключа. Ключи обычно создаются в панели управления, могут быть заменены путем выдачи нового ключа перед аннулированием старого и часто ограничены определенными диапазонами IP-адресов, реферерами или конечными точками.
Ключ в строке запроса так же безопасен, как и ключ в заголовке. URL-адреса записываются в журналы сервера, журналы прокси-сервера и историю браузера и могут просачиваться через заголовок Referer; заголовок тоже не является секретом, но он попадает в гораздо меньшее количество мест.
API отслеживания грузов требует наличия X-API-ключа при записи — POST /cargo/v1/shipments и переходах конечного автомата — в то время как чтение открыто, поэтому один и тот же API отображает обе стороны.
Все термины · Приёмы тестирования · Все 39 mock REST API
Последнее обновление