Boshlanish

CRM API nima

CRM API — bu JSON formatidagi javoblar bilan ishlovchi HTTP API. Uning yordamida tashqi tizim CRM FoodSoul bilan bir xil ma'lumotlar bilan ishlaydi: akkaunt nomidan ularni o'qiydi, yaratadi va o'zgartiradi.

Barcha so‘rovlar HTTPS orqali https://foodsoul.ru/api/crm/v2 manziliga yuboriladi.

API qo‘llanmasida har bir metod batafsil tasvirlangan: parametrlari, so‘rov tanasi, javoblari hamda curl, PHP, JavaScript va Python uchun misollar keltirilgan. API tavsifining to‘liq variantini OpenAPI formatida yuklab olib, uni Postman, Insomnia yoki SDK generatoriga ulash mumkin.

API-tokenni qanday olish mumkin

Integratsiya so‘rovlari API-token orqali avtorizatsiya qilinadi. Tokenni CRM tizimidagi akkaunt egasi yoki administratori «API-tokenlar» bo‘limida chiqaradi.

1. CRM tizimida «API-tokenlar» bo‘limini oching va token yarating.
2. Token rolini tanlang: undan foydalanish mumkin bo‘lgan usullar bog‘liq. Chiqarilgan tokenning rolini o‘zgartirib bo‘lmaydi.
3. Token faqat bitta tarmoqda ishlashi uchun, uni tanlang. Agar tarmoq tanlanmasa, token akkauntdagi barcha tarmoqlarda mavjud bo‘ladi va so‘rovlar chain sarlavhasida tarmoqni uzatadi.
4. Zarur bo‘lsa, tokenning amal qilish muddatini va ruxsat etilgan IP-manzillarni belgilang.
5. Tokenni yaratilgandan so‘ng darhol nusxa oling: ochiq qiymat faqat bir marta ko‘rsatiladi, uni qayta tiklab bo‘lmaydi.

Token fs_api_ bilan boshlanadi va Authorization: Bearer <token> sarlavhasida uzatiladi. Token parol sifatida saqlanadi: uni saytlar va mobil ilovalarning kodida e’lon qilmang va uchinchi shaxslarga bermang. Yo‘qotilgan tokenni CRMning shu bo‘limida bloklang yoki o‘chirib tashlang.

Birinchi so‘rov

Tokeningizni «Foydalanuvchi ma'lumotlarini olish» so‘rovi orqali tekshiring. fs_api_YOUR_TOKEN o‘rniga o‘z tokeningizni kiriting.

Token’dan tashqari, har bir so‘rovda role — ushbu API uchun rol, partner, va language — javobdagi matnlar tili, masalan, uz sarlavhalari yuboriladi.

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

Muvaffaqiyatli javob — HTTP 200 va status: success bo‘lgan JSON, ma’lumotlar esa data maydonida. Xatolik yuz berganda status qiymati error bo‘ladi, xato kodi va matni esa error maydonida ko‘rsatiladi.

Usul tavsifi: Foydalanuvchi ma'lumotlarini olish →

Keyingi qadamlar

• API ma’lumotnomasi — barcha usullar parametrlari, javoblari va so‘rov namunalar bilan
• Avtorizatsiya — avtorizatsiya sarlavhalari va usullarni qabul qiladigan to‘plamlar
• Vebhuklar — tizimingiz manziliga voqealar haqida bildirishnomalar
• Xatoliklar — xatolik kodlari va ularning ma'nolari
• O‘zgarishlar — aPI’da nima o‘zgardi
• OpenAPI-ni yuklab olish · YAML