Început
API CRM FoodSoul pentru afiliați: companii conectate, rapoarte, parteneri contractuali și plăți — direct din propriul sistem, fără a accesa CRM-ul.
Ce este CRM API
CRM API — HTTP API cu răspunsuri în format JSON. Prin intermediul acestuia, un sistem extern lucrează cu aceleași date ca și CRM FoodSoul: le citește, creează și modifică în numele contului.
Toate cererile sunt trimise prin HTTPS la adresa https://foodsoul.ru/api/crm/v2.
Ghidul API descrie fiecare metodă: parametri, corpul cererii, răspunsuri și exemple în curl, PHP, JavaScript și Python. Descrierea completă a API-ului poate fi descărcată în format OpenAPI și integrată în Postman, Insomnia sau într-un generator SDK.
Cum să obții un token API
Solicitările de integrare sunt autorizate printr-un token API. Tokenul este emis de către proprietarul sau administratorul contului în CRM, în secțiunea „Token-uri API”.
- Deschideți în CRM secțiunea „Token-uri API” și creați un token.
- Selectați rolul tokenului: de acesta depind metodele disponibile. Rolul tokenului emis nu poate fi schimbat.
- Dacă este necesar, setați perioada de valabilitate a tokenului și adresele IP permise.
- Copiați tokenul imediat după creare: valoarea afișată este vizibilă o singură dată și nu poate fi recuperată ulterior.
Tokenul începe cu fs_api_ și este transmis în antetul Authorization: Bearer <token>. Tokenul este stocat ca o parolă: nu îl publicați în codul site-urilor sau aplicațiilor mobile și nu îl transmiteți terților. Dacă tokenul este pierdut, blocați-l sau ștergeți-l în aceeași secțiune din CRM.
Prima solicitare
Verificați tokenul cu interogarea „Obține datele utilizatorului”. În loc de fs_api_YOUR_TOKEN, introduceți propriul token.
Pe lângă token, fiecare cerere transmite anteturile role — rolul, pentru acest API affiliate, și language — limba textelor din răspuns, de exemplu ro.
curl -X GET 'https://foodsoul.ru/api/crm/v2/application.user_info' \
-H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
-H 'language: ro' \
-H 'role: affiliate'Răspunsul de succes — HTTP 200 și JSON cu status: success, datele se află în câmpul data. În caz de eroare, status este egal cu error, iar codul și textul erorii se află în câmpul error.
Ce urmează
- Referință API — toate metodele cu parametri, răspunsuri și exemple de cereri
- Autorizare — titluri de autorizare și seturi care acceptă metode
- Webhook-uri — notificări despre evenimente la adresa sistemului dumneavoastră
- Erori — coduri de eroare și semnificațiile lor
- Modificări — ce s-a schimbat în API
- Descarcă OpenAPI · YAML