Սկսել աշխատանքը

Ի՞նչ է CRM API

CRM API — HTTP API JSON ձևաչափով պատասխաններով։ Դրա միջոցով արտաքին համակարգը աշխատում է նույն տվյալների հետ, ինչ 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 վերնագիրը՝ պատասխանի տեքստերի լեզուն, օրինակ՝ hy:.

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

Հաջող պատասխանը՝ HTTP 200 և JSON՝ status: success, տվյալները՝ data դաշտում։ Սխալի դեպքում status-ը հավասար է error, իսկ սխալի կոդը և տեքստը՝ error դաշտում։.

Մեթոդի նկարագրություն: Ստանալ օգտագործողի տվյալները →

Ինչ անել հետո

• API տեղեկատու — բոլոր մեթոդները պարամետրերով, պատասխաններով և հարցման օրինակներով
• Մուտք — մուտքի վերնագրեր և հավաքածուներ, որոնք ընդունում են մեթոդներ
• Վեբհուկեր — համակարգի ձեր հասցեին ուղարկվող իրադարձությունների ծանուցումներ
• Սխալներ — սխալների կոդերը և դրանց նշանակությունները
• Փոփոխություններ — ինչն է փոխվել API-ում
• Ներբեռնել OpenAPI · YAML