Mulai

Apa itu CRM API

CRM API — HTTP API dengan respons dalam format JSON. Melalui API ini, sistem eksternal bekerja dengan data yang sama seperti di CRM FoodSoul: membaca, membuat, dan mengubah data tersebut atas nama akun.

Semua permintaan dikirim melalui HTTPS ke alamat https://foodsoul.ru/api/crm/v2.

Panduan API menjelaskan setiap metode: parameter, body permintaan, respons, serta contoh dalam curl, PHP, JavaScript, dan Python. Deskripsi lengkap API dapat diunduh dalam format OpenAPI dan diintegrasikan ke dalam Postman, Insomnia, atau generator SDK.

Bagaimana cara mendapatkan token API

Permintaan integrasi diotorisasi dengan token API. Token diterbitkan oleh pemilik atau administrator akun di CRM, pada bagian "Token API".

1. Buka bagian "Token API" di CRM dan buat token.
2. Pilih peran token: metode yang tersedia akan bergantung pada peran ini. Peran token yang telah diterbitkan tidak dapat diubah.
3. Agar token hanya berfungsi pada satu jaringan, pilihlah jaringan tersebut. Jika jaringan tidak dipilih, token akan tersedia untuk semua jaringan akun, dan permintaan akan mengirimkan jaringan melalui header chain.
4. Jika perlu, tetapkan masa berlaku token dan alamat IP yang diizinkan.
5. Salin token segera setelah dibuat: nilainya yang terbuka hanya ditampilkan sekali dan tidak dapat dipulihkan kembali.

Token dimulai dengan fs_api_ dan dikirimkan di header Authorization: Bearer <token>. Token disimpan seperti kata sandi: jangan publikasikan di kode situs web dan aplikasi seluler serta jangan berikan kepada pihak ketiga. Jika token hilang, blokir atau hapus di bagian CRM yang sama.

Permintaan Pertama

Periksa token dengan permintaan “Mendapatkan data pengguna”. Ganti fs_api_YOUR_TOKEN dengan token Anda.

Selain token, setiap permintaan juga mengirimkan header role — peran, untuk API ini partner, dan language — bahasa teks dalam respons, misalnya id.

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

Respon yang berhasil — HTTP 200 dan JSON dengan status: success, data terdapat pada kolom data. Jika terjadi kesalahan, status bernilai error, sedangkan kode dan pesan kesalahan terdapat pada kolom error.

Deskripsi metode: Mendapatkan data pengguna →

Apa selanjutnya

• Referensi API — semua metode dengan parameter, respons, dan contoh permintaan
• Otorisasi — judul otorisasi dan set yang menerima metode
• Webhook — notifikasi tentang acara ke alamat sistem Anda
• Kesalahan — kode kesalahan dan artinya
• Perubahan — apa yang berubah di API
• Unduh OpenAPI · YAML