Darbo pradžia

Kas yra CRM API

CRM API — HTTP API su atsakymais JSON formatu. Per jį išorinė sistema dirba su tais pačiais duomenimis, kaip ir CRM FoodSoul: skaito, kuria ir keičia juos paskyros vardu.

Visi užklausimai siunčiami per HTTPS adresu https://foodsoul.pro/api/crm/v2.

API vadovas aprašo kiekvieną metodą: parametrus, užklausos turinį, atsakymus ir pavyzdžius su curl, PHP, JavaScript ir Python. Visą API aprašymą galima atsisiųsti OpenAPI formatu ir prijungti prie Postman, Insomnia arba SDK generatoriaus.

Kaip gauti API raktą

Integracijos užklausos yra autorizuojamos naudojant API raktą. Raktą išduoda paskyros savininkas arba administratorius CRM sistemoje, skiltyje „API raktai“.

1. Atidarykite CRM skyrių „API raktai“ ir sukurkite raktą.
2. Pasirinkite žetono vaidmenį: nuo jo priklauso prieinami metodai. Išduoto žetono vaidmens pakeisti negalima.
3. Jei reikia, nustatykite žetono galiojimo laiką ir leistinus IP adresus.
4. Nukopijuokite žetoną iškart po sukūrimo: atvirą reikšmę galima peržiūrėti tik vieną kartą, jos atkurti neįmanoma.

Žetonas prasideda „fs_api_“ ir perduodamas antraštėje „Authorization: Bearer <žetonas>“. Žetonas saugomas kaip slaptažodis: neskelbkite jo svetainių ar mobiliųjų programėlių kode ir neperduokite trečiosioms šalims. Prarastą žetoną užblokuokite arba ištrinkite tame pačiame CRM skyriuje.

Pirmasis užklausa

Patikrinkite žetoną užklausa „Gauti naudotojo duomenis“. Vietoje fs_api_YOUR_TOKEN įrašykite savo žetoną.

Be to žetono, kiekvienas užklausa perduoda antraštes role — rolė, šiam API affiliate, ir language — atsakymo tekstų kalba, pavyzdžiui, lt.

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

Sėkmingas atsakymas — HTTP 200 ir JSON su status: success, duomenys — lauke data. Klaidos atveju status lygus error, o klaidos kodas ir tekstas — lauke error.

Metodo aprašymas: Gauti naudotojo duomenis →

Kas toliau

• API žinynas — visi metodai su parametrais, atsakymais ir užklausų pavyzdžiais
• Autorizacija — autorizacijos antraštės ir rinkiniai, kurie priima metodus
• Žiniatinklio kabliukai — pranešimai apie įvykius jūsų sistemos adresu
• Klaidų — klaidų kodai ir jų reikšmės
• Pakeitimai — kas pasikeitė API
• Atsisiųsti OpenAPI · YAML