Початок роботи

Що таке CRM API

CRM API — HTTP API з відповідями у форматі JSON. Через нього зовнішня система працює з тими ж даними, що й CRM FoodSoul: читає, створює та змінює їх від імені акаунта.

Усі запити надсилаються через HTTPS на адресу https://foodsoul.pro/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 — мову текстів у відповіді, наприклад uk.

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

<?php

$client = new \GuzzleHttp\Client();

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

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

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

import requests

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

Успішна відповідь — HTTP 200 і JSON зі status: success, дані — у полі data. У разі помилки status дорівнює error, а код і текст помилки — у полі error.

Опис методу: Отримати дані користувача →

Що далі

• Довідник API — усі методи з параметрами, відповідями та прикладами запитів
• Авторизація — заголовки авторизації та набори, які приймають методи
• Вебхуки — сповіщення про події на адресу вашої системи
• Помилки — коди помилок та їх значення
• Зміни — що змінилося в API
• Завантажити OpenAPI · YAML