Authentifizierung

Alle API-Anfragen erfordern ein Bearer-Token (API-Key) zur Authentifizierung.

API-Key erstellen

Melden Sie sich bei IronFlock unter app.ironflock.com an.
Gehen Sie zu Benutzereinstellungen.
Navigieren Sie zum Bereich API Keys.
Klicken Sie auf Create API Key.
Kopieren Sie den generierten Schlüssel — er wird nur einmal angezeigt.

API-Key verwenden

Fügen Sie den Schlüssel im Authorization-Header jeder Anfrage ein:


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

Python-Beispiel


import requests
 
API_KEY = "your-api-key"
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()

JavaScript-Beispiel


const API_KEY = "your-api-key";
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();

Fehlerantworten

Statuscode	Bedeutung
`401`	Fehlender oder ungültiger API-Key
`403`	Unzureichende Berechtigungen für diese Operation
`404`	Ressource nicht gefunden
`422`	Validierungsfehler (überprüfen Sie die Anfrageparameter)
`500`	Interner Serverfehler

Alle Fehlerantworten geben ein JSON-Objekt zurück:


{
    "error": "Description of the error"
}