Аутентификация
Аутентификация
Каждый запрос к API FourA требует аутентификации. На этой странице объясняется, как получить, использовать и управлять вашим API-ключом.
Получение API-ключа
- Войдите в FourA Dashboard
- Перейдите на страницу API Keys
- Нажмите Create Key
- Скопируйте ключ из диалогового окна подтверждения
Ваш API-ключ выглядит так: pk_live_a1b2c3d4e5f6...
Ключи, созданные сегодня, можно просматривать: нажмите значок глаза в строке ключа позже, чтобы по запросу показать полный секрет (см. Managing API Keys для информации о процессе просмотра и разрешениях). Старые ключи, созданные до внедрения этой функции, невозможно показать снова, и они отображаются со значком замка; перегенерируйте их один раз для перехода на новый формат.
Использование API-ключа
Включайте ваш API-ключ в заголовок X-API-Key каждого запроса:
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. Записывайте его в журнал на своей стороне, чтобы служба поддержки могла позже найти конкретный вызов.
Следующие шаги
- Quick Start: Выполните свой первый запрос
- Managing API Keys: Просматривайте, редактируйте, перегенерируйте и удаляйте ключи
- API Endpoints: Полный справочник по endpoint
- Error Handling: Корректно обрабатывайте ошибки аутентификации