Authentifizierung

Zur Authentifizierung an unserer API benötigen Sie einen API-Schlüssel. Diesen können Sie in Ihrem Login im Bereich Entwickler erstellen und einsehen. Mehr dazu erfahren Sie in unserem Hilfeartikel.

API-Schlüssel jetzt erstellen

HTTP Basic Auth

Verwenden Sie HTTP Basic Auth mit Ihrem API-Schlüssel. Der API-Schlüssel wird direkt als Header gesendet, eine weitere Kodierung per Base64 ist nicht erforderlich.

curl https://gateway.seven.io/api/sms \
  -H 'Authorization: basic IHR_API_SCHLÜSSEL'

OAuth2 mit Bearer Token

Voraussetzung zur Authentifizierung ist, dass eine App bei uns registriert ist und der Kunde diese zur Nutzung der API autorisiert hat.

Erfahren Sie mehr zu OAuth2.0 →

curl https://gateway.seven.io/api/sms \
  -H 'Authorization: Bearer ACCESS_TOKEN'

Authentifizierung per HTTP Header

Senden Sie Ihren API Request mit Ihrem API-Schlüssel im X-Api-Key Header

curl https://gateway.seven.io/api/sms \
  -H 'X-Api-Key: IHR_API_SCHLÜSSEL'

Subaccount-Zugriff

Verwalten Sie mehrere Subaccounts unter einem Hauptaccount, können Sie mit einem einzigen API-Schlüssel im Namen jedes beliebigen eigenen Subaccounts agieren. Damit entfällt das separate Erstellen eines API-Schlüssels pro Subaccount für Automatisierungen.

Voraussetzungen

1. Login mit dem Hauptaccount (nicht aus einem Subaccount heraus).
2. Im Entwickler-Bereich beim Anlegen oder Bearbeiten des API-Schlüssels die Option „Zugriff auf Subaccounts" aktivieren.

Verwendung

Senden Sie zusätzlich zum X-Api-Key Header den X-Account-Id Header mit der ID des Ziel-Subaccounts:

curl -G https://gateway.seven.io/api/sms \
  --data-urlencode "to=4917612345678" \
  --data-urlencode "text=hello" \
  -H 'X-Api-Key: IHR_HAUPT_API_SCHLÜSSEL' \
  -H 'X-Account-Id: SUBACCOUNT_ID'

Der Request wird so verarbeitet, als käme er vom Subaccount: Guthaben, Absenderkennungen, Einstellungen und Debugger-Einträge gehören dem Subaccount und werden auch dort abgebucht/abgelegt. Die Scopes des Hauptschlüssels bestimmen weiterhin, welche Endpunkte aufgerufen werden dürfen.

Hinweise

• Die Konfigurationen des Hauptaccounts (IP-Whitelist, Signatur-Pflicht, Scopes) bleiben aktiv - der Schlüssel ist ja der des Hauptaccounts.
• Die Verwaltungs-Endpunkte für Subaccounts selbst (z. B. /subaccounts) sind mit gesetztem X-Account-Id nicht erreichbar, da Subaccounts keine eigenen Subaccounts besitzen.
• Im API-Debugger ist sowohl der verwendete Schlüssel (Hauptaccount) als auch die X-Account-Id (Ziel-Subaccount) ersichtlich.

Authentifizierung per GET/POST Parameter bzw. Benutzer/Passwort

Alternativ zu oben genannten Methoden unterstützen wir weiterhin die Authentifizierung per API-Schlüssel als GET oder POST Parameter p.

Speziell die Übertragung per GET gilt als nicht sicher und sollte daher nicht verwendet werden. Aus Kompatibilitätsgründen ist die veraltete Authentifizierung per Benutzer/Passwort nur noch für ältere Accounts möglich. Hiervon wird dringend abgeraten. Neu angelegte Accounts können sich nicht mit ihrem Login-Passwort authentifizieren und müssen zwingend einen API-Schlüssel verwenden.

curl "https://gateway.seven.io/api/endpunkt?u=IHR_LOGIN&p=IHR_PASSWORT"

curl "https://gateway.seven.io/api/endpunkt?p=IHR_API_SCHLÜSSEL"

curl -X POST "https://gateway.seven.io/api/endpunkt" \
    -d "p=IHR_API_SCHLÜSSEL"