Alustamine

Mis on CRM API

CRM API — HTTP API vastustega JSON-vormingus. Selle kaudu töötab väline süsteem samade andmetega nagu CRM FoodSoul: loeb, loob ja muudab neid konto nimel.

Kõik päringud saadetakse HTTPS-i kaudu aadressile https://foodsoul.ru/api/crm/v2.

API juhend kirjeldab iga meetodit: parameetrid, päringu keha, vastused ning näited curl-i, PHP, JavaScripti ja Pythoni jaoks. API täieliku kirjelduse saab alla laadida OpenAPI formaadis ning ühendada selle Postmani, Insomnia või SDK generaatoriga.

Kuidas saada API-märki

Integratsioonipäringud autoriseeritakse API-tokeni abil. Tokeni väljastab konto omanik või administraator CRM-is, jaotises „API-tokenid“.

1. Avage CRM-is jaotis "API-tokendid" ja looge token.
2. Valige tokeni roll: sellest sõltuvad saadaolevad meetodid. Väljastatud tokeni rolli ei saa muuta.
3. Vajadusel määrake tokeni kehtivusaeg ja lubatud IP-aadressid.
4. Kopeerige token kohe pärast loomist: avatud väärtust näidatakse ainult üks kord, seda ei saa taastada.

Token algab fs_api_-ga ja edastatakse päises Authorization: Bearer <token>. Tokenit hoitakse nagu parooli: ärge avaldage seda veebisaitide või mobiilirakenduste koodis ega edastage kolmandatele isikutele. Kaotatud token blokeerige või kustutage samas CRM-i jaotises.

Esimene päring

Kontrollige tokenit päringuga „Kasutaja andmete pärimine“. Asendage fs_api_YOUR_TOKEN oma tokeniga.

Lisaks tokenile edastab iga päring päised role — roll, selle API jaoks affiliate, ja language — vastuse tekstide keel, näiteks et.

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

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

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

Õnnestunud vastus — HTTP 200 ja JSON, kus status on success, andmed asuvad väljal data. Veakorral on status väärtuseks error, ning vea kood ja tekst asuvad väljal error.

Meetodi kirjeldus: Kasutaja andmete pärimine →

Mis edasi

• API viide — kõik meetodid koos parameetrite, vastuste ja päringunäidetega
• Autoriseerimine — autoriseerimise pealkirjad ja komplektid, mis aktsepteerivad meetodeid
• Veebikonks — teavitused sündmuste kohta teie süsteemi aadressile
• Veateated — veakoodid ja nende tähendused
• Muudatused — mis on API-s muutunud
• Laadi alla OpenAPI · YAML