API-Dokumentation
Dies ist die Dokumentation für die verfügbaren API-Endpunkte, die um die REST-Architektur herum aufgebaut sind. Alle API-Endpunkte geben eine JSON-Antwort unter Verwendung der standardmäßigen HTTP-Antwortcodes zurück und erfordern eine Bearer-Authentifizierung über einen API-Schlüssel.
Authentifizierung
Alle API-Endpunkte benötigen einen API-Schlüssel, der über die Bearer-Authentifizierungsmethode übermittelt wird.
Authorization: Bearer {api_key}
curl --request GET \
--url 'https://staging.gratisqrcode.nl/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://staging.gratisqrcode.nl/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \
Fehler
Unsere API verwendet herkömmliche HTTP-Statuscodes, um den Erfolg oder Misserfolg einer Anfrage anzuzeigen.
{
"errors": [
{
"title": "Sie haben keinen Zugriff auf die API.",
"status": 401
}
]
}
200 Anfrage erfolgreich abgeschlossen
400 Ungültige Anfrage – Erforderliche Parameter fehlen oder sind ungültig
401 Nicht autorisiert – API-Schlüssel fehlt oder ist ungültig
404 Die angeforderte Ressource wurde nicht gefunden
429 Zu viele Anfragen – Ratenbegrenzung überschritten
500 Interner Serverfehler – das bedeutet, dass ein Problem auf unserer Seite vorliegt
Alle API-Endpunkt-Ergebnisse arbeiten mit der UTC-Zeitzone, sofern nicht anders angegeben.