API

Autorización

Cada solicitud a la API de CRM envía encabezados de autorización. Los encabezados necesarios para el método se indican en su página, en el bloque «Autorización».

Las integraciones se autorizan mediante un token de API en el encabezado Authorization. El token de acceso token-access se emite al iniciar sesión a través de la API y es adecuado para aplicaciones que operan en nombre del usuario.

Encabezados

api-token

Encabezado: Authorization · Formato: fs_api_* · Se utiliza en los métodos: 365

Token de API de la sección api_tokens. El valor del encabezado Authorization es Bearer <token>. Token de socio: si al emitir el token se selecciona una cadena, solo funciona con esa cadena y no se requiere el encabezado chain. Si no se selecciona una cadena, el token tiene acceso a todas las cadenas de la cuenta, pero no tiene una cadena activa. Cada solicitud que requiera una cadena debe enviar el encabezado chain, de lo contrario se devuelve el error 117 con field: chain. /chains devuelve las cadenas de la cuenta; /chains.switch no está disponible para el token (error 268).

Ejemplo

Authorization: Bearer fs_api_YOUR_TOKEN

language

Encabezado: language · Se utiliza en los métodos: 374

Idioma de respuesta: código ISO 639-1, por ejemplo, ru

Ejemplo

language: es

role

Encabezado: role · Se utiliza en los métodos: 374

Rol de usuario: partner o affiliate

Ejemplo

role: partner

chain

Encabezado: chain · Se utiliza en los métodos: 0

La red en la que se realiza la solicitud. Obligatorio solo para el token de socio emitido sin selección de red; en los demás casos se ignora

Ejemplo

chain: YOUR_TOKEN

Conjuntos de encabezados

El método acepta uno de los conjuntos. Los conjuntos con un token de API son adecuados para integraciones.

api-token + language + rolemétodos: 365
language + rolemétodos: 9

Errores de acceso

Un token incorrecto, bloqueado o caducado, así como una solicitud sin el encabezado necesario, devuelven un error con un código. Los valores de los códigos se encuentran en la sección «Errores».

Errores →