Začínáme

Co je to CRM API

CRM API — HTTP API s odpověďmi ve formátu JSON. Prostřednictvím něj externí systém pracuje se stejnými daty jako CRM FoodSoul: čte je, vytváří a upravuje jménem účtu.

Všechny požadavky jsou odesílány přes HTTPS na adresu https://foodsoul.ru/api/crm/v2.

Příručka API popisuje každou metodu: parametry, tělo požadavku, odpovědi a příklady v curl, PHP, JavaScriptu a Pythonu. Kompletní popis API lze stáhnout ve formátu OpenAPI a připojit do Postmanu, Insomnie nebo generátoru SDK.

Jak získat API token

Žádosti o integraci jsou autorizovány pomocí API tokenu. Token vydává vlastník nebo administrátor účtu v CRM, v sekci „API tokeny“.

1. Otevřete v CRM sekci „API tokeny“ a vytvořte token.
2. Vyberte roli tokenu: na ní závisí dostupné metody. Roli vydaného tokenu nelze změnit.
3. Aby token fungoval pouze s jednou sítí, vyberte ji. Pokud síť nevyberete, bude token dostupný ve všech sítích účtu a požadavky budou předávat síť v hlavičce chain.
4. V případě potřeby nastavte dobu platnosti tokenu a povolené IP adresy.
5. Zkopírujte token ihned po vytvoření: otevřená hodnota je zobrazena pouze jednou a nelze ji obnovit.

Token začíná na fs_api_ a předává se v hlavičce Authorization: Bearer <token>. Token je uchováván jako heslo: nezveřejňujte jej v kódu webových stránek ani mobilních aplikací a nepředávejte jej třetím stranám. Ztracený token zablokujte nebo odstraňte ve stejné sekci CRM.

První požadavek

Zkontrolujte token pomocí dotazu „Získat údaje o uživateli“. Místo fs_api_YOUR_TOKEN vložte svůj token.

Kromě tokenu každý požadavek předává hlavičky role — roli pro toto API partner a language — jazyk textů v odpovědi, například cs.

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

Úspěšná odpověď — HTTP 200 a JSON s status: success, data jsou v poli data. V případě chyby je status roven error a kód a text chyby jsou v poli error.

Popis metody: Získat údaje o uživateli →

Co dál

• Referenční příručka API — všechny metody s parametry, odpověďmi a příklady dotazů
• Autorizace — hlavičky autorizace a sady, které přijímají metody
• Webhooky — oznámení o událostech na adresu vašeho systému
• Chyby — kódy chyb a jejich významy
• Změny — co se změnilo v API
• Stáhnout OpenAPI · YAML