API başvurusu
Bağlantıyı sına
Anahtarın geçerli olduğunu doğrular; anahtarın adını ve bağlı olduğu işletmeyi döndürür.
GET
https://kurye.firmaniz.com/api/v1/pingEntegrasyonu kurarken ilk çağrınız bu olsun: adres, anahtar ve ağ bağlantısı doğruysa 200 döner. Sistemde hiçbir değişiklik yapmaz.
restaurant_id doluysa anahtar o işletmeye bağlıdır ve siparişler kendiliğinden o işletmeye yazılır. null ise anahtar firma genelidir; sipariş gönderirken işletmeyi siz belirtirsiniz.
Örnek istek
GET /ping
curl "https://kurye.firmaniz.com/api/v1/ping" \
-H "X-Api-Key: $KURYESOFT_API_KEY"Yanıt
200 Başarılı
Anahtar geçerli.
okmantıksalHer zaman
true.keymetinAnahtara panelde verilen ad.
restaurant_idtam sayı · boş olabilirAnahtarın bağlı olduğu işletme; firma geneli anahtarda
null.200 · application/json
{
"ok": true,
"key": "Kasa POS",
"restaurant_id": 1
}Hatalar
Hata gövdesi her zaman { "error": { "code", "message", "fields" } } biçimindedir. Bu uçta karşılaşabileceğiniz kodlar (bütün liste için Hatalar):
Kod
HTTP
Anlamı
API_KEY_REQUIREDHTTP:
401Anlamı:İstekte API anahtarı yok ya da
ks_ ile başlamıyor.API_KEY_INVALIDHTTP:
401Anlamı:Anahtar yanlış, silinmiş ya da pasif.
İpucu:
429 RATE_LIMITED ve 5xx yanıtlarında kısa bir beklemeyle yeniden deneyin. Bkz. Yeniden deneme.