Autorização

Cada solicitação à API do CRM envia cabeçalhos de autorização. Os cabeçalhos necessários para o método estão indicados em sua página, no bloco "Autorização".

As integrações são autorizadas por meio de um token de API no cabeçalho Authorization. O token de acesso token-access é emitido ao fazer login via API e é adequado para aplicativos que operam em nome do usuário.

Cabeçalhos

`api-token`

Cabeçalho: Authorization · Formato: fs_api_* · Usado nos métodos: 365

Token de API da seção api_tokens. O valor do cabeçalho Authorization é Bearer <token>. Token de parceiro: se uma rede for selecionada ao emitir o token, ele funciona apenas com essa rede e o cabeçalho chain não é necessário. Se nenhuma rede for selecionada, o token tem acesso a todas as redes da conta, mas não possui uma rede ativa. Cada requisição que exige uma rede deve enviar o cabeçalho chain, caso contrário, será retornado o erro 117 com field: chain. O endpoint /chains retorna as redes da conta; /chains.switch não está disponível para o token (erro 268).

Exemplo

Authorization: Bearer fs_api_YOUR_TOKEN

`language`

Cabeçalho: language · Usado nos métodos: 374

Idioma de resposta — código ISO 639-1, por exemplo, ru

Exemplo

language: pt

`role`

Cabeçalho: role · Usado nos métodos: 374

Função do usuário: partner ou affiliate

Exemplo

role: partner

`chain`

Cabeçalho: chain · Usado nos métodos: 0

A rede na qual a solicitação é executada. Obrigatório apenas para o token de parceiro emitido sem seleção de rede; nos demais casos, é ignorado

Exemplo

chain: YOUR_TOKEN

Conjuntos de cabeçalhos

O método aceita um dos conjuntos. Os conjuntos com token de API são adequados para integrações.

`api-token` + `language` + `role`	métodos: 365
`language` + `role`	métodos: 9

Erros de acesso

Um token inválido, bloqueado ou expirado, assim como uma solicitação sem o cabeçalho necessário, retornam um erro com um código. Os valores dos códigos estão na seção «Erros».

Erros →