Darba sākšana

Kas ir CRM API

CRM API — HTTP API ar atbildēm JSON formātā. Ar tā palīdzību ārējā sistēma strādā ar tiem pašiem datiem, ar kuriem darbojas arī CRM FoodSoul: lasa, izveido un maina tos konta vārdā.

Visi pieprasījumi tiek nosūtīti, izmantojot HTTPS, uz adresi https://foodsoul.ru/api/crm/v2.

API rokasgrāmata apraksta katru metodi: parametrus, pieprasījuma ķermeni, atbildes un piemērus curl, PHP, JavaScript un Python valodās. Pilnu API aprakstu var lejupielādēt OpenAPI formātā un pievienot Postman, Insomnia vai SDK ģeneratoram.

Kā iegūt API pilnvaru

Integrācijas pieprasījumi tiek autorizēti ar API pilnvaru. Pilnvaru izsniedz konta īpašnieks vai administrators CRM sadaļā "API pilnvaras".

1. Atveriet CRM sadaļu "API marķieri" un izveidojiet marķieri.
2. Izvēlieties marķiera lomu: no tās ir atkarīgas pieejamās metodes. Izveidotā marķiera lomu nevar mainīt.
3. Lai tokens darbotos tikai ar vienu tīklu, izvēlieties to. Ja tīkls nav izvēlēts, tokenam ir pieejami visi konta tīkli, un pieprasījumos tīkls tiek nodots galvenē chain.
4. Ja nepieciešams, norādiet tokena derīguma termiņu un atļautās IP adreses.
5. Kopējiet tokenu uzreiz pēc izveides: atklātā vērtība tiek parādīta tikai vienu reizi, to nevar atjaunot.

Tokens sākas ar fs_api_ un tiek nodots galvenē Authorization: Bearer <token>. Tokens tiek glabāts kā parole: nepublicējiet to vietņu un mobilo lietotņu kodā un nenododiet trešajām personām. Nozaudētu tokenu bloķējiet vai izdzēsiet tajā pašā CRM sadaļā.

Pirmais pieprasījums

Pārbaudiet tokenu ar pieprasījumu «Iegūt lietotāja datus». Tā vietā, lai izmantotu fs_api_YOUR_TOKEN, ievietojiet savu tokenu.

Papildus tokenam katrs pieprasījums nosūta galvenes role — loma šim API partner, un language — atbilžu tekstu valoda, piemēram, lv.

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

Veiksmīga atbilde — HTTP 200 un JSON ar status: success, dati — laukā data. Kļūdas gadījumā status ir error, bet kļūdas kods un teksts — laukā error.

Metodes apraksts: Iegūt lietotāja datus →

Kas tālāk

• API uzziņu grāmata — visi paņēmieni ar parametriem, atbildēm un pieprasījumu piemēriem
• Autorizācija — autorizācijas virsraksti un komplekti, kas pieņem metodes
• Tīmekļa āķi — paziņojumi par notikumiem uz jūsu sistēmas adresi
• Kļūdas — kļūdu kodi un to nozīmes
• Izmaiņas — kas ir mainījies API
• Lejupielādēt OpenAPI · YAML