Бастау

CRM API дегеніміз не

CRM API — жауаптары JSON форматында берілетін HTTP API. Осы арқылы сыртқы жүйе CRM FoodSoul-дағыдай деректермен жұмыс істейді: аккаунт атынан оларды оқиды, жасайды және өзгертеді.

Барлық сұраныстар HTTPS арқылы https://foodsoul.pro/api/crm/v2 мекенжайына жіберіледі.

API анықтамалығы әрбір әдісті сипаттайды: параметрлерін, сұраныс денесін, жауаптарын және curl, PHP, JavaScript пен Python тілдеріндегі мысалдарды қамтиды. API сипаттамасын толықтай OpenAPI форматында жүктеп алып, оны Postman, Insomnia немесе SDK генераторына қосуға болады.

API-токенді қалай алуға болады

Интеграциялық сұраныстар API-токен арқылы авторизацияланады. Токенді CRM жүйесіндегі «API-токендер» бөлімінде аккаунт иесі немесе әкімші шығарады.

1. CRM жүйесінде «API-токендер» бөлімін ашып, токен жасаңыз.
2. Токеннің рөлін таңдаңыз: оған қолжетімді әдістер байланысты. Шығарылған токеннің рөлін өзгерту мүмкін емес.
3. Қажет болған жағдайда токеннің қолданылу мерзімін және рұқсат етілген IP-мекенжайларды көрсетіңіз.
4. Токенді бірден жасағаннан кейін көшіріп алыңыз: ашық мәні бір рет қана көрсетіледі, оны қайта қалпына келтіру мүмкін емес.

Токен fs_api_ деп басталады және Authorization: Bearer <токен> тақырыбында жіберіледі. Токен құпиясөз сияқты сақталады: оны сайттар мен мобильді қосымшалардың кодында жарияламаңыз және үшінші тұлғаларға бермеңіз. Жоғалған токенді CRM жүйесіндегі сол бөлімде бұғаттаңыз немесе өшіріңіз.

Алғашқы сұраныс

«Пайдаланушы деректерін алу» сұрауын пайдаланып токенді тексеріңіз. fs_api_YOUR_TOKEN орнына өз токеніңізді қойыңыз.

Токеннен бөлек, әрбір сұраныс role — осы API үшін рөлді affiliate, және language — жауаптағы мәтіндердің тілін, мысалы kk деген тақырыптарды жібереді.

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

<?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' => 'kk',
        'role' => 'affiliate',
    ],
]);

$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": "kk",
        "role": "affiliate"
    },
})
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": "kk",
        "role": "affiliate",
    },
)
data = response.json()

Сәтті жауап — HTTP 200 және status: success мәні бар JSON, деректер — data өрісінде. Қате болған жағдайда status мәні error, ал қате коды мен мәтіні — error өрісінде.

Әдістің сипаттамасы: Пайдаланушы деректерін алу →

Келесі қадамдар

• API анықтамалығы — барлық әдістер параметрлерімен, жауаптарымен және сұраныс үлгілерімен
• Авторизация — авторизация тақырыптары және әдістерді қабылдайтын жиынтықтар
• Вебхуктар — жүйеңіздің мекенжайына оқиғалар туралы хабарламалар
• Қателер — қате кодтары және олардың мағыналары
• Өзгерістер — aPI-де не өзгерді
• OpenAPI жүктеп алу · YAML