დასაწყისი

რა არის 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. იმისათვის, რომ ტოკენი მუშაობდეს მხოლოდ ერთ ქსელთან, აირჩიეთ იგი. ქსელის არჩევის გარეშე ტოკენს ხელმისაწვდომია ანგარიშის ყველა ქსელი და მოთხოვნები გადასცემს ქსელს სათაურში chain.
4. საჭიროების შემთხვევაში მიუთითეთ ტოკენის მოქმედების ვადა და ნებადართული IP-მისამართები.
5. დააკოპირეთ ტოკენი შექმნისთანავე: ღია მნიშვნელობა ნაჩვენებია მხოლოდ ერთხელ, მისი აღდგენა შეუძლებელია.

ტოკენი იწყება fs_api_-ით და გადაეცემა სათაურით Authorization: Bearer <ტოკენი>. ტოკენი ინახება როგორც პაროლი: არ გამოაქვეყნოთ იგი ვებგვერდებისა და მობილური აპლიკაციების კოდში და არ გადასცეთ მესამე პირებს. დაკარგული ტოკენი დაბლოკეთ ან წაშალეთ CRM-ის იმავე განყოფილებაში.

პირველი მოთხოვნა

შეამოწმეთ ტოკენი მოთხოვნით „მომხმარებლის მონაცემების მიღება“. fs_api_YOUR_TOKEN-ის ნაცვლად ჩასვით თქვენი ტოკენი.

გარდა ტოკენისა, თითოეული მოთხოვნა გადასცემს ჰედერებს role — როლი, ამ API-სთვის partner, და language — პასუხში ტექსტების ენა, მაგალითად ka.

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

წარმატებული პასუხი — HTTP 200 და JSON ველი status: success, მონაცემები — ველში data. შეცდომის შემთხვევაში status არის error, ხოლო შეცდომის კოდი და ტექსტი — ველში error.

მეთოდის აღწერა: მომხმარებლის მონაცემების მიღება →

შემდეგი ნაბიჯები

• API-ის ცნობარი — ყველა მეთოდი პარამეტრებით, პასუხებით და მოთხოვნის მაგალითებით
• ავტორიზაცია — ავტორიზაციის სათაურები და ნაკრებები, რომლებიც მეთოდებს იღებენ
• ვებჰუკები — შეტყობინებები თქვენი სისტემის მისამართზე მოვლენების შესახებ
• შეცდომები — შეცდომის კოდები და მათი მნიშვნელობები
• ცვლილებები — რა შეიცვალა API-ში
• OpenAPI-ს ჩამოტვირთვა · YAML