Comenzar

¿Qué es la API de CRM?

CRM API es una API HTTP con respuestas en formato JSON. A través de ella, un sistema externo trabaja con los mismos datos que el CRM FoodSoul: los lee, crea y modifica en nombre de la cuenta.

Todas las solicitudes se envían por HTTPS a la dirección https://foodsoul.ru/api/crm/v2.

La guía de la API describe cada método: parámetros, cuerpo de la solicitud, respuestas y ejemplos en curl, PHP, JavaScript y Python. La descripción completa de la API se puede descargar en formato OpenAPI y conectar en Postman, Insomnia o un generador de SDK.

Cómo obtener un token de API

Las solicitudes de integración se autorizan mediante un token de API. El token es emitido por el propietario o administrador de la cuenta en el CRM, en la sección "Tokens de API".

1. Abra la sección "Tokens de API" en el CRM y cree un token.
2. Elija el rol del token: de ello dependen los métodos disponibles. El rol del token emitido no se puede cambiar.
3. Para que el token funcione solo con una red, selecciónela. Si no se selecciona ninguna red, el token tendrá acceso a todas las redes de la cuenta y las solicitudes transmitirán la red en el encabezado chain.
4. Si es necesario, establezca la fecha de caducidad del token y las direcciones IP permitidas.
5. Copia el token inmediatamente después de crearlo: el valor visible se muestra solo una vez y no se puede recuperar.

El token comienza con fs_api_ y se transmite en el encabezado Authorization: Bearer <token>. El token se almacena como una contraseña: no lo publiques en el código de sitios web ni aplicaciones móviles y no lo compartas con terceros. Si pierdes el token, bloquéalo o elimínalo en la misma sección de CRM.

Primera solicitud

Verifique el token con la solicitud «Obtener datos del usuario». En lugar de fs_api_YOUR_TOKEN, introduzca su propio token.

Además del token, cada solicitud envía los encabezados role — el rol para esta API partner, y language — el idioma de los textos en la respuesta, por ejemplo es.

curl -X GET 'https://foodsoul.ru/api/crm/v2/application.user_info' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: es' \
  -H 'role: partner'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://foodsoul.ru/api/crm/v2/application.user_info', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'es',
        'role' => 'partner',
    ],
]);

$data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.ru/api/crm/v2/application.user_info", {
    method: "GET",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "es",
        "role": "partner"
    },
})
const data = await response.json()

import requests

response = requests.request(
    "GET",
    "https://foodsoul.ru/api/crm/v2/application.user_info",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "es",
        "role": "partner",
    },
)
data = response.json()

Respuesta exitosa: HTTP 200 y un JSON con status: success, los datos se encuentran en el campo data. En caso de error, status es igual a error, y el código y el mensaje de error están en el campo error.

Descripción del método: Obtener datos del usuario →

¿Qué sigue?

• Referencia de la API — todos los métodos con parámetros, respuestas y ejemplos de solicitudes
• Autorización — títulos de autorización y conjuntos que aceptan métodos
• Webhooks — notificaciones sobre eventos a la dirección de su sistema
• Errores — códigos de error y sus significados
• Cambios — ¿qué ha cambiado en la API?
• Descargar OpenAPI · YAML