Uwierzytelnianie

Wszystkie żądania API wymagają tokena Bearer (klucza API) do uwierzytelniania.

Tworzenie klucza API

Zaloguj się do IronFlock na app.ironflock.com.
Przejdź do Ustawień użytkownika.
Przejdź do sekcji Klucze API.
Kliknij Utwórz klucz API.
Skopiuj wygenerowany klucz — jest pokazywany tylko raz.

Używanie klucza API

Dołącz klucz w nagłówku Authorization każdego żądania:


curl -H "Authorization: Bearer TWÓJ_KLUCZ_API" \
     https://api.ironflock.com/v1/ironflock/devices

Przykład Python


import requests
 
API_KEY = "twój-klucz-api"
BASE_URL = "https://api.ironflock.com/v1/ironflock"
 
headers = {"Authorization": f"Bearer {API_KEY}"}
 
response = requests.get(f"{BASE_URL}/devices", headers=headers)
devices = response.json()

Przykład JavaScript


const API_KEY = "twój-klucz-api";
const BASE_URL = "https://api.ironflock.com/v1/ironflock";
 
const response = await fetch(`${BASE_URL}/devices`, {
    headers: { Authorization: `Bearer ${API_KEY}` }
});
const devices = await response.json();

Odpowiedzi błędów

Kod statusu	Znaczenie
`401`	Brakujący lub nieprawidłowy klucz API
`403`	Niewystarczające uprawnienia dla tej operacji
`404`	Zasób nie znaleziony
`422`	Błąd walidacji (sprawdź parametry żądania)
`500`	Wewnętrzny błąd serwera

Wszystkie odpowiedzi błędów zwracają obiekt JSON:


{
    "error": "Opis błędu"
}