Başlarken
Kimlik doğrulama
Anahtarı göndermek
Anahtarı her istekte X-Api-Key başlığında gönderin. Kullandığınız HTTP kütüphanesi yalnızca Authorization başlığını destekliyorsa aynı anahtar Bearer biçiminde de kabul edilir:
curl "https://kurye.firmaniz.com/api/v1/ping" -H "X-Api-Key: ks_ANAHTARINIZ"
curl "https://kurye.firmaniz.com/api/v1/ping" -H "Authorization: Bearer ks_ANAHTARINIZ"Anahtar her zaman ks_ ile başlar ve 43 karakterdir. İstekler yalnızca HTTPS üzerinden yapılır.
Anahtar türleri
Kurye firmasının yöneticisi anahtarı oluştururken onu bir işletmeye bağlayabilir ya da firma geneli bırakabilir:
restaurant_id / restaurant_code yok sayılır.404 döner.POST /orders ve POST /quote isteğinde restaurant_id ya da restaurant_code gönderilir; gönderilmezse 422.Bir işletmenin kendi POS'u ya da sitesi için işletmeye bağlı anahtar kullanın. Firma geneli anahtar, birden çok işletmeye sipariş aktaran yazılımlar (zincir restoran merkezi, çağrı merkezi, toplu sipariş platformu) içindir. Anahtarın türünü GET /ping yanıtındaki restaurant_id ile öğrenebilirsiniz.
Anahtarın oluşturulması ve yönetimi
Anahtarları yalnızca kurye firmasının yetkili yöneticisi yönetir: panelde Ayarlar → API Anahtarları ve Webhook → API Anahtarları. İşletme kullanıcıları ve geliştiriciler anahtar oluşturamaz.
- Bir kez gösterilir. Sistem anahtarın yalnızca özetini saklar; kaybedilen anahtar geri getirilemez, yenisi oluşturulur.
- Son kullanım panelde görünür (en çok dakikada bir güncellenir); kullanılmayan anahtarları bununla ayıklayabilirsiniz.
- Pasif yapma ve silme hemen etkili olur: sonraki istek
401 API_KEY_INVALIDalır.
Anahtarı yenilemek
Kesintisiz yenilemek için:
- Kurye firmanızdan yeni bir anahtar isteyin (eskisi çalışmaya devam eder).
- Yeni anahtarı sisteminize yükleyin ve bir istekle sınayın.
- Eski anahtarı pasif yaptırın ya da sildirin.
Güvenli kullanım
Anahtar yalnızca sunucunuzda durur
API anahtarı, işletme adına sipariş açma ve iptal etme yetkisi verir. Tarayıcıda çalışan koda, mobil uygulamaya ya da herkese açık bir depoya koymayın. Tarayıcıdan yapılan istekler zaten engellenir (CORS); müşterinin cihazı sizin sunucunuzla, sizin sunucunuz KuryeSoft ile konuşmalıdır.
- Anahtarı ortam değişkeninde ya da gizli bilgi yöneticisinde (secret manager) saklayın; kaynak koduna yazmayın.
- Anahtarı günlüklere (log) yazmayın. Hata ayıklarken ilk 8 karakteri yeterlidir; panel de anahtarı bu ön ekle gösterir.
- Her yazılım ya da kurulum için ayrı anahtar isteyin: biri sızarsa yalnızca o kapatılır.
- Anahtarın sızdığından şüphelenirseniz hemen kurye firmanıza pasif yaptırın.
Kimlik hataları
{
"error": {
"code": "API_KEY_INVALID",
"message": "API anahtarı geçersiz"
}
}API_KEY_REQUIREDks_ ile başlamıyor.API_KEY_INVALID