Başlarken

CRM API nedir

CRM API — JSON formatında yanıtlar veren bir HTTP API'dir. Dış sistem, bu API aracılığıyla CRM FoodSoul ile aynı veriler üzerinde çalışır: hesabın adına verileri okur, oluşturur ve değiştirir.

Tüm istekler HTTPS üzerinden https://foodsoul.pro/api/crm/v2 adresine gönderilir.

API kılavuzu, her yöntemi açıklar: parametreler, istek gövdesi, yanıtlar ve curl, PHP, JavaScript ve Python için örnekler. API'nin tamamının açıklamasını OpenAPI formatında indirip Postman, Insomnia veya bir SDK oluşturucuya entegre edebilirsiniz.

API jetonunu nasıl alabilirim

Entegrasyon istekleri API belirteci ile yetkilendirilir. Belirteç, CRM'deki "API belirteçleri" bölümünde hesap sahibi veya yönetici tarafından oluşturulur.

1. CRM'de "API Anahtarları" bölümünü açın ve bir anahtar oluşturun.
2. Token rolünü seçin: kullanılabilir yöntemler buna bağlıdır. Yayınlanan tokenin rolü değiştirilemez.
3. Gerekirse, tokenin geçerlilik süresini ve izin verilen IP adreslerini belirleyin.
4. Token’i oluşturduktan hemen sonra kopyalayın: açık değer yalnızca bir kez gösterilir, daha восстановить edilemez.

Token fs_api_ ile başlar ve Authorization: Bearer <token> başlığıyla iletilir. Token bir şifre gibi saklanır: onu web siteleri ve mobil uygulamalarda kod içinde yayınlamayın ve üçüncü şahıslara vermeyin. Kaybolan tokeni aynı CRM bölümünde engelleyin veya silin.

İlk istek

Tokeninizi "Kullanıcı verilerini al" isteğiyle kontrol edin. fs_api_YOUR_TOKEN yerine kendi tokeninizi girin.

Token dışında, her istek ayrıca role — bu API için rol affiliate ve language — yanıttaki metinlerin dili, örneğin tr başlıklarını iletir.

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

Başarılı bir yanıt — HTTP 200 ve status: success olan bir JSON, veriler ise data alanında bulunur. Hata durumunda status değeri error olur, hata kodu ve metni ise error alanında yer alır.

Yöntemin açıklaması: Kullanıcı verilerini al →

Sırada ne var

• API Referansı — tüm yöntemler, parametreleri, yanıtları ve istek örnekleri ile
• Yetkilendirme — yetkilendirme başlıkları ve yöntemleri kabul eden setler
• Webhook'lar — sisteminize ait adrese etkinlik bildirimleri
• Hatalar — hata kodları ve anlamları
• Değişiklikler — aPI'de ne değişti?
• OpenAPI'yi İndir · YAML