Autorisation
Chaque requête à l'API CRM transmet des en-têtes d'autorisation. Les en-têtes requis pour une méthode sont indiqués sur sa page, dans la section « Autorisation ».
Les intégrations s'autorisent à l'aide d'un jeton API dans l'en-tête Authorization. Le jeton d'accès token-access est délivré lors de la connexion via l'API et convient aux applications fonctionnant au nom de l'utilisateur.
En-têtes
api-token
En-tête: Authorization · Format: fs_api_* · Utilisé dans les méthodes : 365
Le jeton API provient de la section api_tokens. La valeur de l’en-tête Authorization est Bearer <jeton>.
Jeton partenaire : si un réseau est sélectionné lors de la génération du jeton, il ne fonctionne qu’avec ce réseau et l’en-tête chain n’est pas requis. Si aucun réseau n’est sélectionné, le jeton a accès à tous les réseaux du compte, mais il n’a pas de réseau actif. Chaque requête nécessitant un réseau doit inclure l’en-tête chain, sinon l’erreur 117 avec field: chain est retournée.
/chains retourne les réseaux du compte ; /chains.switch n’est pas disponible pour le jeton (erreur 268).
Exemple
Authorization: Bearer fs_api_YOUR_TOKENlanguage
En-tête: language · Utilisé dans les méthodes : 374
Langue de la réponse — code ISO 639-1, par exemple ru
Exemple
language: frrole
En-tête: role · Utilisé dans les méthodes : 374
Rôle de l'utilisateur : partner ou affiliate
Exemple
role: partnerchain
En-tête: chain · Utilisé dans les méthodes : 0
Réseau sur lequel la requête est exécutée. Obligatoire uniquement pour un jeton partenaire émis sans sélection de réseau ; ignoré dans les autres cas
Exemple
chain: YOUR_TOKENEnsembles d'en-têtes
La méthode accepte l’un des ensembles. Les ensembles avec un jeton API conviennent pour les intégrations.
api-token + language + role | méthodes : 365 |
language + role | méthodes : 9 |
Erreurs d'accès
Un jeton invalide, bloqué ou expiré, ainsi qu'une requête sans l'en-tête requis, renvoient une erreur avec un code. Les valeurs des codes se trouvent dans la section « Erreurs ».
Erreurs →