Autorizzazione
Ogni richiesta all'API CRM trasmette gli header di autorizzazione. Gli header necessari per il metodo sono indicati nella sua pagina, nel blocco "Autorizzazione".
Le integrazioni si autorizzano tramite un token API nell'intestazione Authorization. Il token di accesso token-access viene rilasciato al momento dell'accesso tramite API ed è adatto alle applicazioni che operano per conto dell'utente.
Intestazioni
api-token
Intestazione: Authorization · Formato: fs_api_* · Utilizzato nei metodi: 47
Token API dalla sezione api_tokens. Il valore dell’header Authorization è Bearer <token>.
Token partner: se durante l’emissione del token è stata selezionata una rete, il token funziona solo con quella rete e l’header chain non è necessario. Se nessuna rete è stata selezionata, il token ha accesso a tutte le reti dell’account, ma non ha una rete attiva. Ogni richiesta che richiede una rete deve includere l’header chain, altrimenti viene restituito l’errore 117 con field: chain.
/chains restituisce le reti dell’account; /chains.switch non è disponibile per il token (errore 268).
Esempio
Authorization: Bearer fs_api_YOUR_TOKENlanguage
Intestazione: language · Utilizzato nei metodi: 56
Lingua della risposta — codice ISO 639-1, ad esempio ru
Esempio
language: itrole
Intestazione: role · Utilizzato nei metodi: 56
Ruolo utente: partner o affiliate
Esempio
role: affiliatechain
Intestazione: chain · Utilizzato nei metodi: 0
La rete su cui viene eseguita la richiesta. Obbligatorio solo per il token partner emesso senza selezione della rete; negli altri casi viene ignorato
Esempio
chain: YOUR_TOKENSet di intestazioni
Il metodo accetta uno dei set. I set con token API sono adatti per le integrazioni.
api-token + language + role | metodi: 47 |
language + role | metodi: 9 |
Errori di accesso
Un token non valido, bloccato o scaduto e una richiesta senza l’intestazione necessaria restituiscono un errore con un codice. I valori dei codici sono riportati nella sezione «Errori».
Errori →