Аутентификация
Аутентификация
Каждый request к FourA API требует аутентификации. На этой странице описано, как получить, использовать и управлять вашим API key.
Получение API Key
- Войдите в FourA Dashboard
- Перейдите на страницу API Keys
- Нажмите Create Key
- Скопируйте ключ из диалогового окна подтверждения
Ваш API key выглядит так: pk_live_a1b2c3d4e5f6...
Созданные сегодня ключи можно просматривать: нажмите на иконку глаза в строке ключа, чтобы отобразить полный secret по запросу (см. Управление 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 |
Каждый ответ, успешный или с ошибкой, содержит заголовок X-Foura-Request-Id, за исключением случаев, когда FourA вообще не может прочитать тело запроса (некорректный JSON или тело более 100 KB), который отклоняется до назначения ID. Логируйте его на своей стороне, чтобы служба поддержки могла найти конкретный вызов позже.
Следующие шаги
- Быстрый старт: Сделайте свой первый request
- Управление API keys: Просмотр, редактирование, перегенерация и удаление ключей
- API Endpoints: Полный справочник по endpoint
- Обработка ошибок: Корректная обработка ошибок аутентификации