📚 API Dokümantasyonu

RESTful API ile Synaptix'i uygulamanıza entegre edin

v2.0 ✓ Stable

📖 İçindekiler

🚀 Başlangıç

Synaptix API, RESTful mimari kullanır ve JSON formatında veri döner. Tüm istekler HTTPS üzerinden yapılmalıdır.

Base URL

https://api.synaptixai.services/v2

Hızlı Başlangıç

cURL 
curl -X GET "https://api.synaptixai.services/v2/chatbots" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

🔐 Kimlik Doğrulama

API istekleri için Bearer token kullanılır. API anahtarınızı dashboard'dan alabilirsiniz.

Authorization Header 
Authorization: Bearer sk_live_abc123xyz456
⚠️ Güvenlik Uyarısı: API anahtarlarınızı asla public repository'lerde paylaşmayın. Environment variables kullanın.

🤖 Chatbots

GET /chatbots

Tüm chatbot'larınızı listeler.

Response

{
  "data": [
    {
      "id": "bot_abc123",
      "name": "Customer Support Bot",
      "status": "active",
      "language": "tr",
      "created_at": "2026-01-15T10:30:00Z"
    }
  ],
  "total": 1,
  "page": 1
}
POST /chatbots

Yeni bir chatbot oluşturur.

Request Body

{
  "name": "Sales Bot",
  "language": "en",
  "model": "gpt-4o",
  "training_data": [
    {
      "type": "url",
      "content": "https://example.com/faq"
    }
  ]
}

💬 Messages

POST /messages

Chatbot'a mesaj gönderir ve yanıt alır.

Request Body

{
  "chatbot_id": "bot_abc123",
  "message": "Merhaba, yardımcı olabilir misiniz?",
  "user_id": "user_xyz789",
  "language": "tr"
}

Response

{
  "id": "msg_def456",
  "chatbot_id": "bot_abc123",
  "message": "Merhaba! Elbette yardımcı olabilirim. Size nasıl yardımcı olabilirim?",
  "language": "tr",
  "confidence": 0.95,
  "timestamp": "2026-01-28T14:30:00Z"
}

🔔 Webhooks

Webhook'lar ile gerçek zamanlı event'leri dinleyebilirsiniz.

Desteklenen Event'ler

  • message.received - Yeni mesaj alındığında
  • message.sent - Mesaj gönderildiğinde
  • conversation.started - Yeni konuşma başladığında
  • conversation.ended - Konuşma sonlandığında

Webhook Payload

{
  "event": "message.received",
  "timestamp": "2026-01-28T14:30:00Z",
  "data": {
    "message_id": "msg_abc123",
    "chatbot_id": "bot_xyz789",
    "user_id": "user_def456",
    "content": "Merhaba"
  }
}

⚠️ Error Handling

API, standart HTTP status code'ları kullanır.

Status Code Açıklama
200 Başarılı istek
400 Hatalı istek (Bad Request)
401 Yetkisiz erişim (Unauthorized)
404 Kaynak bulunamadı (Not Found)
429 Rate limit aşıldı
500 Sunucu hatası

Error Response

{
  "error": {
    "code": "invalid_request",
    "message": "Chatbot ID is required",
    "details": {
      "field": "chatbot_id",
      "issue": "missing"
    }
  }
}

⏱️ Rate Limits

API istekleri için rate limit uygulanır.

Plan Requests/Minute Requests/Day
Starter 60 10,000
Pro 300 100,000
Enterprise Unlimited Unlimited

Rate Limit Headers

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 45
X-RateLimit-Reset: 1706450400

📦 SDK'lar

Resmi SDK'larımız ile hızlıca entegre olun.

JavaScript / Node.js

npm install @synaptix/sdk

Python

pip install synaptix

PHP

composer require synaptix/sdk

Ruby

gem install synaptix