Iniziare

Cos'è l'API CRM

CRM API — HTTP API con risposte in formato JSON. Attraverso di esso, un sistema esterno lavora con gli stessi dati della CRM FoodSoul: li legge, li crea e li modifica per conto dell’account.

Tutte le richieste vengono inviate tramite HTTPS all'indirizzo https://foodsoul.ru/api/crm/v2.

La guida API descrive ogni metodo: parametri, corpo della richiesta, risposte ed esempi in curl, PHP, JavaScript e Python. La descrizione completa dell’API può essere scaricata in formato OpenAPI e importata in Postman, Insomnia o in un generatore di SDK.

Come ottenere un token API

Le richieste di integrazione vengono autorizzate tramite un token API. Il token viene emesso dal proprietario o dall'amministratore dell'account nel CRM, nella sezione "Token API".

1. Aprite la sezione "Token API" nel CRM e create un token.
2. Seleziona il ruolo del token: da esso dipendono i metodi disponibili. Il ruolo del token emesso non può essere modificato.
3. Se necessario, impostare la durata del token e gli indirizzi IP autorizzati.
4. Copia il token subito dopo la creazione: il valore in chiaro viene mostrato una sola volta e non potrà essere recuperato.

Il token inizia con fs_api_ e viene trasmesso nell'intestazione Authorization: Bearer <token>. Il token va conservato come una password: non pubblicarlo nel codice dei siti web o delle applicazioni mobili e non trasmetterlo a terzi. In caso di smarrimento, blocca o elimina il token nella stessa sezione del CRM.

Prima richiesta

Verificate il token con la richiesta «Ottenere i dati dell'utente». Al posto di fs_api_YOUR_TOKEN inserite il vostro token.

Oltre al token, ogni richiesta invia anche le intestazioni role — il ruolo, per questa API affiliate, e language — la lingua dei testi nella risposta, ad esempio it.

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

Risposta riuscita — HTTP 200 e JSON con status: success, i dati si trovano nel campo data. In caso di errore, status è uguale a error, mentre il codice e il testo dell'errore sono nel campo error.

Descrizione del metodo: Ottenere i dati dell'utente →

Cosa fare dopo

• Riferimento API — tutti i metodi con parametri, risposte ed esempi di richieste
• Autorizzazione — titoli di autorizzazione e set che accettano i metodi
• Webhook — notifiche sugli eventi all'indirizzo del vostro sistema
• Errori — codici di errore e i loro significati
• Modifiche — cosa è cambiato nell'API
• Scarica OpenAPI · YAML