Аутентификация
Каждый request к FourA API требует аутентификации. На этой странице описано, как получить, использовать и управлять вашим API key.
Получение API key
- Войдите в FourA Dashboard
- Перейдите на страницу API Keys
- Нажмите Create Key
- Скопируйте key из диалогового окна подтверждения
Ваш API key выглядит так: pk_live_a1b2c3d4e5f6...
Созданные сейчас ключи можно просматривать: нажмите на иконку глаза в строке ключа, чтобы снова отобразить полный секрет при необходимости (см. раздел Managing API Keys для подробностей о процедуре просмотра и правах доступа). Устаревшие ключи, созданные до появления этой функции, нельзя просмотреть повторно, и они помечены иконкой замка; перевыпустите их один раз для перехода на новый формат.
Использование API key
Указывайте ваш API key в header X-API-Key каждого request:
curl -X POST https://eu.api.foura.ai/api/single/ \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"method": "GET", "url": "https://example.com"}'
В Python:
import requests
response = requests.post(
"https://eu.api.foura.ai/api/single/",
headers={
"X-API-Key": "YOUR_API_KEY",
"Content-Type": "application/json"
},
json={"method": "GET", "url": "https://example.com"}
)
В Node.js:
const response = await fetch('https://eu.api.foura.ai/api/single/', {
method: 'POST',
headers: {
'X-API-Key': 'YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({ method: 'GET', url: 'https://example.com' })
});
Безопасность API-ключа
Относитесь к API-ключу как к паролю:
- Не коммитьте его в систему контроля версий. Используйте переменные окружения.
- Не раскрывайте его в клиентском коде. Используйте его только в серверных приложениях.
- Выполняйте ротацию при компрометации. Сгенерируйте ключ заново в Dashboard. Старый секрет перестает действовать в течение минуты, а каждый просмотр фиксируется в журнале аудита, поэтому украденные учетные данные легко обнаружить постфактум.
Использование переменных окружения
Сохраните ключ в переменную окружения:
export FOURA_API_KEY="pk_live_a1b2c3d4e5f6..."
Затем укажите его в своем коде:
import os
api_key = os.environ["FOURA_API_KEY"]
const apiKey = process.env.FOURA_API_KEY;
Частые ошибки аутентификации
Все сбои аутентификации возвращают статус 401 Unauthorized.
| Ошибка | Сообщение | Причина | Решение |
|---|---|---|---|
| 401 | Missing API key. Include X-API-Key header. | В запросе отсутствует заголовок X-API-Key |
Добавьте заголовок X-API-Key |
| 401 | Invalid API key | Неверный ключ, лишние пробелы или деактивированный ключ | Проверьте ключ, удалите пробелы или создайте новый ключ в Dashboard |
Если FourA временно не может проверить ключ, например во время переключения базы данных, возвращается 503 с API key check temporarily unavailable и Retry-After: 5, но никогда не 401. Повторите запрос после этого ожидания: с вашим ключом все в порядке.
Каждый ответ, успешный или с ошибкой, содержит заголовок X-Foura-Request-Id, кроме случаев, когда FourA вообще не может прочитать тело (некорректный JSON или тело больше 100 КБ), отклоняемых до назначения ID. Логируйте его на своей стороне, чтобы служба поддержки могла найти конкретный вызов.
Следующие шаги
- Быстрый старт: Сделайте свой первый запрос
- Управление API ключами: Просмотр, редактирование, перевыпуск и удаление ключей
- API Endpoints: Полный справочник endpoint
- Обработка ошибок: Корректная обработка ошибок аутентификации