Uwierzytelnianie

Każde żądanie do FourA API wymaga uwierzytelnienia. Na tej stronie wyjaśniono, jak uzyskać, stosować i zarządzać swoim kluczem API key.

Uzyskiwanie klucza API key

1. Zaloguj się do FourA Dashboard
2. Przejdź do strony API Keys
3. Kliknij Create Key
4. Skopiuj klucz z okna dialogowego z potwierdzeniem

Twój klucz API key wygląda następująco: pk_live_a1b2c3d4e5f6...

Nowo utworzone klucze można odsłonić: kliknij ikonę oka w wierszu klucza, aby w razie potrzeby ponownie wyświetlić pełną wartość (zobacz Zarządzanie kluczami API key, aby poznać proces odsłaniania i uprawnienia). Starsze klucze, utworzone przed wprowadzeniem tej funkcji, nie mogą zostać ponownie wyświetlone i mają ikonę kłódki; wygeneruj je ponownie, aby przejść na nowy standard.

Używanie klucza API key

Dołącz swój klucz API key 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 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 commituj go do systemu kontroli wersji. Zamiast tego używaj zmiennych środowiskowych.
• Nie ujawniaj go w kodzie po stronie klienta. Używaj go wyłącznie w aplikacjach po stronie serwera.
• Rotuj w przypadku naruszenia bezpieczeństwa. Wygeneruj klucz ponownie w Dashboardzie. Stary klucz przestanie działać w ciągu minuty, a każde jego wyświetlenie jest rejestrowane w dzienniku audytu, co ułatwia wykrycie skradzionych danych uwierzytelniających.

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 kodzie:

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

const apiKey = process.env.FOURA_API_KEY;

Typowe błędy uwierzytelniania

Wszystkie niepowodzenia uwierzytelniania zwracają status 401 Unauthorized.

Każda odpowiedź, zakończona sukcesem lub błędem, zawiera nagłówek X-Foura-Request-Id, z wyjątkiem treści, której FourA nie może w ogóle odczytać (nieprawidłowy JSON lub treść powyżej 100 KB), odrzucanej przed przypisaniem identyfikatora. Zapisuj go w logach po swojej stronie, aby wsparcie techniczne mogło później odszukać konkretne wywołanie.

Kolejne kroki

• Szybki start: Wykonaj swoje pierwsze żądanie
• Zarządzanie kluczami API: Odkrywaj, edytuj, odnawiaj i usuwaj klucze
• Punkty końcowe API: Pełna dokumentacja punktów końcowych
• Obsługa błędów: Prawidłowo obsługuj błędy uwierzytelniania