Authentifizierung

Jede Anfrage an die CRM-API überträgt Autorisierungs-Header. Welche Header für eine Methode erforderlich sind, ist auf deren Seite im Abschnitt „Autorisierung“ angegeben.

Integrationen werden mit einem API-Token im Header Authorization autorisiert. Das Zugriffstoken token-access wird bei der Anmeldung über die API ausgegeben und eignet sich für Anwendungen, die im Namen des Benutzers arbeiten.

Überschriften

`api-token`

Kopfzeile: Authorization · Format: fs_api_* · Wird in Methoden verwendet: 365

API-Token aus dem Abschnitt api_tokens. Der Wert des Headers Authorization ist Bearer <Token>. Partner-Token: Wenn beim Ausstellen des Tokens ein Netzwerk ausgewählt wurde, funktioniert er nur mit diesem Netzwerk und der Header chain ist nicht erforderlich. Wenn kein Netzwerk ausgewählt wurde, hat der Token Zugriff auf alle Netzwerke des Accounts, aber kein aktives Netzwerk. Jede Anfrage, die ein Netzwerk benötigt, muss den Header chain übergeben, andernfalls wird Fehler 117 mit field: chain zurückgegeben. /chains gibt die Netzwerke des Accounts zurück; /chains.switch ist für den Token nicht verfügbar (Fehler 268).

Beispiel

Authorization: Bearer fs_api_YOUR_TOKEN

`language`

Kopfzeile: language · Wird in Methoden verwendet: 374

Antwortsprache — ISO 639-1-Code, z. B. ru

Beispiel

language: de

`role`

Kopfzeile: role · Wird in Methoden verwendet: 374

Benutzerrolle: partner oder affiliate

Beispiel

role: partner

`chain`

Kopfzeile: chain · Wird in Methoden verwendet: 0

Das Netzwerk, in dem die Anfrage ausgeführt wird. Erforderlich nur für ein Partner-Token, das ohne Netzauswahl ausgestellt wurde; in allen anderen Fällen wird dieser Parameter ignoriert

Beispiel

chain: YOUR_TOKEN

Header-Sets

Die Methode akzeptiert eines der Sets. Sets mit einem API-Token eignen sich für Integrationen.

`api-token` + `language` + `role`	methoden: 365
`language` + `role`	methoden: 9

Zugriffsfehler

Ein ungültiges, gesperrtes oder abgelaufenes Token sowie eine Anfrage ohne den erforderlichen Header führen zu einem Fehler mit einem Code. Die Bedeutung der Codes finden Sie im Abschnitt „Fehler“.

Fehler →