Удостоверяване
Удостоверяване
Всяка заявка към API на FourA изисква удостоверяване. Тази страница обяснява как да получите, използвате и управлявате вашия API ключ.
Получаване на вашия API ключ
- Влезте в FourA Dashboard
- Отидете на страницата API Keys
- Кликнете върху Create Key
- Копирайте ключа от диалоговия прозорец за потвърждение
Вашият API ключ изглежда така: pk_live_a1b2c3d4e5f6...
Ключовете, създадени днес, могат да бъдат разкривани: кликнете върху иконата с око на реда на ключа по-късно, за да върнете пълната тайна при поискване (вижте Управление на API ключове за процеса на разкриване и правата). Старите ключове, създадени преди въвеждането на тази функция, не могат да бъдат върнати и показват икона с катинар; генерирайте ги отново веднъж, за да преминете към новия формат.
Използване на вашия API ключ
Включете вашия API ключ в X-API-Key header на всяка заявка:
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 ключ като към парола:
- Не го качвайте в система за контрол на версиите. Вместо това използвайте променливи на средата.
- Не го излагайте в клиентски код. Използвайте го само в сървърни приложения.
- Сменете го, ако е компрометиран. Генерирайте ключа отново от FourA 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 header |
Добавете X-API-Key header |
| 401 | Invalid API key | Грешен ключ, допълнителни интервали или деактивиран ключ | Проверете ключа, премахнете интервалите или създайте нов ключ от Dashboard |
Всеки отговор, успешен или неуспешен, съдържа X-Foura-Request-Id header. Записвайте го в логовете си, за да може екипът по поддръжката да провери конкретното извикване по-късно.
Следващи стъпки
- Бърз старт: Направете първата си заявка
- Управление на API ключове: Разкриване, редактиране, регенериране и изтриване на ключове
- API Endpoints: Пълна справка за endpoint-ите
- Обработка на грешки: Обработвайте грешките при удостоверяване правилно