Удостоверяване
Всяка заявка към FourA API изисква автентикация. Тази страница обяснява как да получите, използвате и управлявате своя API key.
Получаване на вашия API key
- Влезте в FourA Dashboard
- Отидете на страницата API Keys
- Кликнете върху Create Key
- Копирайте ключа от диалоговия прозорец за потвърждение
Вашият API key изглежда така: pk_live_a1b2c3d4e5f6...
Ключовете, създадени днес, могат да се показват: кликнете върху иконата с око на реда на ключа по-късно, за да видите отново пълната тайна при поискване (вижте Управление на API keys за процеса на разкриване и разрешенията). Старите ключове, създадени преди въвеждането на показването, не могат да бъдат показани отново и имат икона с катинар; регенерирайте ги еднократно, за да преминете към новия вариант.
Използване на вашия API key
Включвайте вашия API key в заглавката 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 |
Ако FourA не може да провери ключ за момент, например по време на превключване на базата данни, връща 503 с API key check temporarily unavailable и Retry-After: 5, никога 401. Опитайте отново след това изчакване: ключът ви е наред.
Всеки отговор, успешен или неуспешен, съдържа заглавка X-Foura-Request-Id, освен при тяло, което FourA изобщо не може да разчете (невалиден JSON или тяло над 100 KB), което се отхвърля преди присвояване на ID. Записвайте го в логовете от ваша страна, за да може поддръжката да намери конкретното повикване по-късно.
Следващи стъпки
- Бърз старт: Направете първата си заявка
- Управление на API ключове: Показване, редактиране, прегенериране и изтриване на ключове
- API крайни точки: Пълна документация за крайните точки
- Обработка на грешки: Елегантно справяне с грешки при автентикация