Начало работы

Что такое CRM API

CRM API — HTTP API с ответами в формате JSON. Через него внешняя система работает с теми же данными, что и CRM FoodSoul: читает, создаёт и изменяет их от имени аккаунта.

Все запросы отправляются по HTTPS на адрес https://foodsoul.ru/api/crm/v2.

Справочник API описывает каждый метод: параметры, тело запроса, ответы и примеры на curl, PHP, JavaScript и Python. Описание API целиком можно скачать в формате OpenAPI и подключить в Postman, Insomnia или генератор SDK.

Как получить API-токен

Запросы интеграций авторизуются API-токеном. Токен выпускает владелец или администратор аккаунта в CRM, в разделе «API-токены».

1. Откройте в CRM раздел «API-токены» и создайте токен.
2. Выберите роль токена: от неё зависят доступные методы. Роль выпущенного токена изменить нельзя.
3. При необходимости задайте срок действия токена и разрешённые IP-адреса.
4. Скопируйте токен сразу после создания: открытое значение показывается один раз, восстановить его нельзя.

Токен начинается с fs_api_ и передаётся в заголовке Authorization: Bearer <токен>. Токен хранится как пароль: не публикуйте его в коде сайтов и мобильных приложений и не передавайте третьим лицам. Утерянный токен заблокируйте или удалите в том же разделе CRM.

Первый запрос

Проверьте токен запросом «Получить данные пользователя». Вместо fs_api_YOUR_TOKEN подставьте свой токен.

Кроме токена, каждый запрос передаёт заголовки role — роль, для этого API affiliate, и language — язык текстов в ответе, например ru.

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

<?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' => 'ru',
        'role' => 'affiliate',
    ],
]);

$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": "ru",
        "role": "affiliate"
    },
})
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": "ru",
        "role": "affiliate",
    },
)
data = response.json()

Успешный ответ — HTTP 200 и JSON со status: success, данные — в поле data. При ошибке status равен error, а код и текст ошибки — в поле error.

Описание метода: Получить данные пользователя →

Что дальше

• Справочник API — все методы с параметрами, ответами и примерами запросов
• Авторизация — заголовки авторизации и наборы, которые принимают методы
• Вебхуки — уведомления о событиях на адрес вашей системы
• Ошибки — коды ошибок и их значения
• Изменения — что поменялось в API
• Скачать OpenAPI · YAML