DocsAuthentifizierung
Erfahren Sie, wie Sie sich bei der Cost+ API authentifizieren
Die gesamte Kommunikation mit der Cost+ API erfordert TLS 1.2 oder höher und HTTP Basic Authentication.
So funktioniert Basic Auth
Authentifizieren Sie sich, indem Sie Ihren API-Schlüssel als Benutzernamen mit einem leeren Passwort verwenden. Base64-kodieren Sie die Zeichenkette \{api_key\}: (beachten Sie den abschließenden Doppelpunkt — das Passwort ist leer).
Der resultierende Authorization-Header sieht folgendermaßen aus:
Authorization: Basic aHVudGVyMjo=Geben Sie Ihren API-Schlüssel niemals in clientseitigem Code oder öffentlichen Repositories preis. Bewahren Sie ihn ausschließlich serverseitig auf.
Verwendung von cURL
Standardmethode (empfohlen)
cURL unterstützt Basic Auth nativ mit dem -u-Flag. Übergeben Sie Ihren API-Schlüssel gefolgt von einem Doppelpunkt:
curl -u YOUR_API_KEY: https://api.costplus.online/v1/orders/Manuelle Base64-Kodierung
Wenn Sie den Header selbst erstellen möchten, kodieren Sie zunächst den Schlüssel:
echo -n "YOUR_API_KEY:" | base64Übergeben Sie dann den kodierten Wert im Authorization-Header:
curl -H "Authorization: Basic YOUR_BASE64_ENCODED_KEY" https://api.costplus.online/v1/orders/Der abschließende Doppelpunkt nach dem API-Schlüssel ist erforderlich — er trennt den Benutzernamen vom (leeren) Passwort im Basic-Auth-Schema.
HTTP-Statuscodes
Die API verwendet Standard-HTTP-Statuscodes, um das Ergebnis einer Anfrage anzuzeigen.
| Statuscode | Bedeutung | Beschreibung |
|---|---|---|
| 200 | OK | Anfrage erfolgreich. |
| 201 | Created | Ressource wurde erfolgreich erstellt. |
| 400 | Bad Request | Die Anfrage war fehlerhaft oder es fehlten erforderliche Felder. |
| 401 | Unauthorized | Authentifizierung fehlgeschlagen — überprüfen Sie Ihren API-Schlüssel. |
| 403 | Forbidden | Sie haben keine Berechtigung, auf diese Ressource zuzugreifen. |
| 404 | Not Found | Die angeforderte Ressource existiert nicht. |
| 500 | Internal Server Error | Auf unserer Seite ist ein Fehler aufgetreten. |
| 502 | Bad Gateway | Upstream-Dienstfehler. |
| 503 | Service Unavailable | Die API ist vorübergehend nicht verfügbar. |
| 504 | Gateway Timeout | Der Upstream-Dienst hat nicht rechtzeitig geantwortet. |