API Dokümantasyonu - Norbis Kurumsal Çözümler

1 Kimlik Doğrulama

Norbis API, Bearer Token tabanlı kimlik doğrulama kullanır. API anahtarınızı kurumsal panelinizin Ayarlar > API Erişimi bölümünden oluşturabilirsiniz.

Tüm isteklerde Authorization header'ında API anahtarınızı göndermeniz gerekmektedir:

                    Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
                

Dikkat: API anahtarınızı güvenli bir şekilde saklayın. Anahtarınızı kaynak kodunuzda veya herkese açık alanlarda paylaşmayın. Anahtarınız ele geçirildiğinde kurumsal panelden iptal edip yenisini oluşturabilirsiniz.

2 Base URL

Tüm API istekleri aşağıdaki temel URL üzerinden yapılır:

https://api.norbis.com.tr/v1

API yalnızca HTTPS üzerinden erişilebilir. HTTP istekleri otomatik olarak reddedilir.

3 Endpoint'ler

Mevcut API endpoint'leri aşağıda listelenmiştir:

GET /employees Çalışan listesi

POST /coupons/generate Kupon oluştur

GET /coupons/{id} Kupon detayı

GET /balance Bakiye sorgula

GET /reports/usage Kullanım raporu

Örnek İstek

                    # Çalışan listesini getir
curl -X GET https://api.norbis.com.tr/v1/employees \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
                

Örnek Yanıt

                    {
  "success": true,
  "data": [
    {
      "id": "emp_abc123",
      "name": "Ahmet Yılmaz",
      "phone": "+905551234567",
      "balance": 500.00,
      "status": "active"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 20,
    "total": 156
  }
}
                

4 Rate Limits

API istekleri plan tipine göre sınırlandırılmıştır:

Plan	Rate Limit	Günlük Limit
Profesyonel	100 istek/dakika	10.000 istek/gün
Kurumsal	1.000 istek/dakika	100.000 istek/gün

Rate limit aşıldığında 429 Too Many Requests yanıtı döner. Yanıt header'larında kalan istek sayısı ve sıfırlanma zamanı bilgisi bulunur:

                    X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1706140800
                

5 Hata Kodları

API, standart HTTP durum kodları ile hata yanıtları döner:

Kod	Durum	Açıklama
`400`	Bad Request	Geçersiz istek parametreleri
`401`	Unauthorized	Geçersiz veya eksik API anahtarı
`403`	Forbidden	Bu işlem için yetkiniz yok
`404`	Not Found	İstenen kaynak bulunamadı
`429`	Too Many Requests	Rate limit aşıldı
`500`	Internal Server Error	Sunucu hatası, lütfen tekrar deneyin

Hata Yanıt Formatı

                    {
  "success": false,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "Geçersiz API anahtarı.",
    "status": 401
  }
}
                

6 SDK'lar

Entegrasyonu kolaylaştırmak için resmi SDK'larımızı kullanabilirsiniz:

Node.js Mevcut

Python Mevcut

PHP Yakında

Node.js Kurulum

npm install @norbisai/sdk

Python Kurulum

pip install norbisai

Hızlı Başlangıç (Node.js)

                    const { NorbisAI } = require('@norbisai/sdk');

const client = new NorbisAI({
  apiKey: 'YOUR_API_KEY'
});

// Çalışan listesini getir
const employees = await client.employees.list();

// Kupon oluştur
const coupon = await client.coupons.generate({
  employeeId: 'emp_abc123',
  brand: 'migros',
  amount: 100
});
                

API erişimi Profesyonel ve Kurumsal planlarda mevcuttur.

Planınızı yükselterek API erişimi kazanın ve sisteminizi entegre edin. Avantajlı teklifler için bize başvurun →