Pierwsze kroki

CRM API FoodSoul łączy zewnętrzne systemy z kontem sieci: zamówienia, menu, filie, klienci, bonusy i powiadomienia o zdarzeniach.

Czym jest CRM API

CRM API — HTTP API z odpowiedziami w formacie JSON. Za jego pomocą system zewnętrzny pracuje z tymi samymi danymi, co CRM FoodSoul: odczytuje je, tworzy i modyfikuje w imieniu konta.

Wszystkie żądania są wysyłane przez HTTPS na adres https://foodsoul.ru/api/crm/v2.

Przewodnik API opisuje każdą metodę: parametry, ciało żądania, odpowiedzi oraz przykłady w curl, PHP, JavaScript i Pythonie. Pełny opis API można pobrać w formacie OpenAPI i zaimportować do Postman, Insomnia lub generatora SDK.

Jak uzyskać token API

Żądania integracyjne są autoryzowane za pomocą tokena API. Token jest wydawany przez właściciela lub administratora konta w CRM, w sekcji „Tokeny API”.

Otwórz w CRM sekcję „API-tokens” i utwórz token.
Wybierz rolę tokena: od niej zależą dostępne metody. Roli wydanego tokena nie można zmienić.
Aby token działał tylko z jedną siecią, wybierz ją. Jeśli nie wybierzesz sieci, token będzie miał dostęp do wszystkich sieci konta, a żądania będą przekazywać sieć w nagłówku chain.
W razie potrzeby ustaw okres ważności tokena oraz dozwolone adresy IP.
Skopiuj token od razu po utworzeniu: jawna wartość jest wyświetlana tylko raz i nie można jej odzyskać.

Token zaczyna się od fs_api_ i jest przekazywany w nagłówku Authorization: Bearer <token>. Token jest przechowywany jak hasło: nie publikuj go w kodzie stron internetowych ani aplikacji mobilnych i nie przekazuj osobom trzecim. Utracony token zablokuj lub usuń w tej samej sekcji CRM.

Pierwsze zapytanie

Sprawdź token za pomocą zapytania „Pobierz dane użytkownika”. Zamiast fs_api_YOUR_TOKEN wstaw swój token.

Oprócz tokena, każde żądanie przekazuje nagłówki role — rola, dla tego API partner, oraz language — język tekstów w odpowiedzi, na przykład pl.

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

Pomyślna odpowiedź — HTTP 200 oraz JSON z polem status: success, dane znajdują się w polu data. W przypadku błędu status ma wartość error, a kod i opis błędu znajdują się w polu error.

Opis metody: Pobierz dane użytkownika →

Co dalej

Dokumentacja API — wszystkie metody z parametrami, odpowiedziami i przykładami zapytań
Autoryzacja — nagłówki autoryzacji i zestawy, które akceptują metody
Webhooki — powiadomienia o wydarzeniach na adres Twojego systemu
Błędy — kody błędów i ich znaczenia
Zmiany — co się zmieniło w API
Pobierz OpenAPI · YAML