Commencer

Qu'est-ce que l'API CRM

CRM API — une API HTTP avec des réponses au format JSON. Elle permet à un système externe de travailler avec les mêmes données que le CRM FoodSoul : lire, créer et modifier ces données au nom du compte.

Toutes les requêtes sont envoyées en HTTPS à l'adresse https://foodsoul.ru/api/crm/v2.

Le guide de l’API décrit chaque méthode : paramètres, corps de la requête, réponses et exemples en curl, PHP, JavaScript et Python. La description complète de l’API peut être téléchargée au format OpenAPI et intégrée dans Postman, Insomnia ou un générateur de SDK.

Comment obtenir un jeton API

Les requêtes d'intégration sont autorisées à l'aide d'un jeton API. Le jeton est émis par le propriétaire ou l'administrateur du compte dans le CRM, dans la section « Jetons API ».

1. Ouvrez la section « Jetons API » dans le CRM et créez un jeton.
2. Choisissez le rôle du jeton : les méthodes disponibles en dépendent. Le rôle du jeton émis ne peut pas être modifié.
3. Pour que le jeton ne fonctionne qu’avec un seul réseau, sélectionnez-le. Si aucun réseau n’est choisi, le jeton aura accès à tous les réseaux du compte et les requêtes transmettront le réseau dans l’en-tête chain.
4. Si nécessaire, définissez la durée de validité du jeton et les adresses IP autorisées.
5. Copiez le jeton immédiatement après sa création : la valeur affichée n’est visible qu’une seule fois et ne pourra pas être récupérée ultérieurement.

Le jeton commence par « fs_api_ » et est transmis dans l’en-tête « Authorization: Bearer <jeton> ». Le jeton est conservé comme un mot de passe : ne le publiez pas dans le code des sites web ou des applications mobiles et ne le transmettez pas à des tiers. Si le jeton est perdu, bloquez-le ou supprimez-le dans la même section du CRM.

Première requête

Vérifiez le jeton avec la requête « Obtenir les données de l'utilisateur ». Remplacez fs_api_YOUR_TOKEN par votre propre jeton.

Outre le jeton, chaque requête transmet les en-têtes role — le rôle, pour cette API partner, et language — la langue des textes dans la réponse, par exemple fr.

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

Réponse réussie — HTTP 200 et JSON avec status : success, les données se trouvent dans le champ data. En cas d’erreur, status est égal à error, et le code ainsi que le message d’erreur se trouvent dans le champ error.

Description de la méthode: Obtenir les données de l'utilisateur →

Et ensuite

• Référence de l’API — toutes les méthodes avec paramètres, réponses et exemples de requêtes
• Autorisation — titres d'autorisation et ensembles acceptant des méthodes
• Webhooks — notifications d'événements à l'adresse de votre système
• Erreurs — codes d’erreur et leurs significations
• Modifications — qu'est-ce qui a changé dans l'API
• Télécharger OpenAPI · YAML