Başlanğıc

CRM API nədir

CRM API — JSON formatında cavablar verən HTTP API-dir. Onun vasitəsilə xarici sistem CRM FoodSoul ilə eyni məlumatlarla işləyir: onları hesab adından oxuyur, yaradır və dəyişir.

Bütün sorğular HTTPS vasitəsilə https://foodsoul.pro/api/crm/v2 ünvanına göndərilir.

API bələdçisi hər bir metodu təsvir edir: parametrlər, sorğu gövdəsi, cavablar və curl, PHP, JavaScript və Python üçün nümunələr. API-nin tam təsvirini OpenAPI formatında yükləmək və onu Postman, Insomnia və ya SDK generatoruna qoşmaq mümkündür.

API tokenunu necə əldə etmək olar

İnteqrasiya sorğuları API tokeni ilə avtorizasiya olunur. Tokeni CRM-də hesab sahibi və ya administratoru "API tokenləri" bölməsində yaradır.

1. CRM-də «API-tokenlər» bölməsini açın və token yaradın.
2. Tokenun rolunu seçin: mövcud metodlar ondan asılıdır. Buraxılmış tokenin rolunu dəyişmək mümkün deyil.
3. Tokenun yalnız bir şəbəkə ilə işləməsi üçün onu seçin. Şəbəkə seçilmədikdə, token hesabın bütün şəbəkələrinə açıq olur və sorğularda şəbəkə chain başlığında ötürülür.
4. Zərurət olduqda, tokenin etibarlılıq müddətini və icazə verilən IP ünvanlarını təyin edin.
5. Tokenu dərhal yaradıldıqdan sonra kopyalayın: açıq dəyər yalnız bir dəfə göstərilir, onu bərpa etmək mümkün deyil.

Token fs_api_ ilə başlayır və Authorization: Bearer <token> başlığı vasitəsilə ötürülür. Token parol kimi saxlanılır: onu saytların və mobil tətbiqlərin kodunda paylaşmayın və üçüncü şəxslərə ötürməyin. İtirilmiş tokeni həmin CRM bölməsində bloklayın və ya silin.

İlk sorğu

Tokenu «İstifadəçi məlumatlarını əldə et» sorğusu ilə yoxlayın. fs_api_YOUR_TOKEN əvəzinə öz tokeninizi daxil edin.

Token-dan əlavə olaraq, hər bir sorğu role — bu API üçün rol, partner, və language — cavabda mətnlərin dili, məsələn, az başlıqlarını ötürür.

curl -X GET 'https://foodsoul.pro/api/crm/v2/application.user_info' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: az' \
  -H 'role: partner'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/application.user_info', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'az',
        'role' => 'partner',
    ],
]);

$data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.pro/api/crm/v2/application.user_info", {
    method: "GET",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "az",
        "role": "partner"
    },
})
const data = await response.json()

import requests

response = requests.request(
    "GET",
    "https://foodsoul.pro/api/crm/v2/application.user_info",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "az",
        "role": "partner",
    },
)
data = response.json()

Uğurlu cavab — HTTP 200 və status: success olan JSON, məlumatlar isə data sahəsindədir. Səhv olduqda status error olur, səhv kodu və mətn isə error sahəsində göstərilir.

Metodun təsviri: İstifadəçi məlumatlarını əldə et →

Növbəti addımlar

• API arayışı — bütün metodlar parametrlərlə, cavablarla və sorğu nümunələri ilə
• Avtorizasiya — avtorizasiya başlıqları və metodları qəbul edən dəstlər
• Vebhuklar — sisteminizin ünvanına hadisələr barədə bildirişlər
• Səhvlər — səhv kodları və onların mənaları
• Dəyişikliklər — aPI-də nə dəyişib
• OpenAPI-ni yüklə · YAML