Getting Started

What is the CRM API

CRM API is an HTTP API with responses in JSON format. Through it, an external system works with the same data as the FoodSoul CRM: it reads, creates, and modifies them on behalf of the account.

All requests are sent via HTTPS to the https://foodsoul.ru/api/crm/v2 address.

The API reference describes each method: parameters, request body, responses, and examples in curl, PHP, JavaScript, and Python. The complete API documentation can be downloaded in OpenAPI format and imported into Postman, Insomnia, or an SDK generator.

How to obtain an API token

Integration requests are authorized using an API token. The token is issued by the account owner or administrator in the CRM, under the "API Tokens" section.

1. Open the "API Tokens" section in the CRM and create a token.
2. Select the token role: available methods depend on it. The role of an issued token cannot be changed.
3. If necessary, set the token expiration date and the allowed IP addresses.
4. Copy the token immediately after creation: the plain value is shown only once and cannot be recovered.

The token starts with fs_api_ and is transmitted in the header Authorization: Bearer <token>. The token is stored like a password: do not publish it in website or mobile app code and do not share it with third parties. If the token is lost, block or delete it in the same section of the CRM.

First request

Check the token with the "Get user data" request. Replace fs_api_YOUR_TOKEN with your own token.

In addition to the token, each request sends the headers role — the role for this API affiliate, and language — the language of the texts in the response, for example en.

curl -X GET 'https://foodsoul.ru/api/crm/v2/application.user_info' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: en' \
  -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' => 'en',
        '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": "en",
        "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": "en",
        "role": "affiliate",
    },
)
data = response.json()

A successful response returns HTTP 200 and a JSON object with status: success; the data is in the data field. In case of an error, status is set to error, and the error code and message are provided in the error field.

Method description: Get user data →

What's next

• API Reference — all methods with parameters, responses, and sample requests
• Authorization — authorization headers and sets that accept methods
• Webhooks — event notifications to your system address
• Errors — error codes and their meanings
• Changelog — what has changed in the API
• Download OpenAPI · YAML