Uwierzytelnianie

Każde żądanie do API FourA wymaga uwierzytelnienia. Ta strona wyjaśnia, jak uzyskać, używać i zarządzać swoim kluczem API.

Uzyskiwanie klucza API

1. Zaloguj się do FourA Dashboard
2. Przejdź do strony Klucze API
3. Kliknij Utwórz klucz
4. Skopiuj klucz z okna dialogowego potwierdzenia

Twój klucz API wygląda tak: pk_live_a1b2c3d4e5f6...

Klucze utworzone dzisiaj można odkryć: kliknij ikonę oka w wierszu klucza, aby na żądanie przywrócić pełny sekret (zobacz Zarządzanie kluczami API, aby poznać proces odkrywania i uprawnienia). Starsze klucze, utworzone przed wprowadzeniem tej funkcji, nie mogą być przywrócone i mają ikonę kłódki; wygeneruj je ponownie, aby przejść na nowy system.

Używanie klucza API

Dołącz swój klucz API w nagłówku X-API-Key każdego żądania:

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"}'

W Pythonie:

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"}
)

W środowisku 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' })
});

Bezpieczeństwo klucza API

Traktuj swój klucz API jak hasło:

• Nie umieszczaj go w systemie kontroli wersji. Zamiast tego używaj zmiennych środowiskowych.
• Nie ujawniaj go w kodzie po stronie klienta. Używaj go tylko w aplikacjach po stronie serwera.
• Zmień klucz, jeśli został skompromitowany. Wygeneruj go ponownie w panelu Dashboard. Stary sekret natychmiast przestaje działać, a każde jego odkrycie jest rejestrowane w logach audytu, co ułatwia wykrycie skradzionych danych po fakcie.

Używanie zmiennych środowiskowych

Przechowuj swój klucz w zmiennej środowiskowej:

export FOURA_API_KEY="pk_live_a1b2c3d4e5f6..."

Następnie odwołaj się do niego w swoim kodzie:

import os
api_key = os.environ["FOURA_API_KEY"]

const apiKey = process.env.FOURA_API_KEY;

Typowe błędy uwierzytelniania

Wszystkie błędy uwierzytelniania zwracają status 401 Unauthorized.

Każda odpowiedź, zakończona sukcesem lub błędem, zawiera nagłówek X-Foura-Request-Id. Loguj go po swojej stronie, aby pomoc techniczna mogła później sprawdzić konkretne wywołanie.

Następne kroki

• Szybki start: Wykonaj swoje pierwsze żądanie
• Zarządzanie kluczami API: Odkrywaj, edytuj, generuj ponownie i usuwaj klucze
• Endpointy API: Pełna dokumentacja endpointów
• Obsługa błędów: Odpowiednio obsługuj błędy uwierzytelniania