İçeriğe geç
KuryeSoft

API başvurusu

Mesafe ve ücret hesapla

Sipariş göndermeden önce adresin hizmet bölgesinde olup olmadığını, mesafeyi ve teslimat ücretini öğrenin.
POSThttps://kurye.firmaniz.com/api/v1/quote

Ödeme ekranında müşteri adresini seçtiğinde çağırın: adres hizmet dışındaysa siparişi baştan almayabilirsiniz. Sistemde kayıt oluşturmaz.

Adres hizmet dışındaysa hata dönmez; yanıt 200 ile { "ok": false, "message": "..." } olur. message müşteriye gösterilebilir.

Ücret, kurye firmasının işletmeye tanımladığı fiyat profiliyle hesaplanır. Profil ödeme türüne ya da paket sayısına göre değişiyorsa kesin ücret siparişte hesaplanır ve buradakinden farklı olabilir.

İstek gövdesi

Content-Type: application/json. Belirtilmeyen alanlar varsayılan değeriyle kabul edilir; tanımsız alanlar yok sayılır.

restaurant_idtam sayıkoşullu
İşletmenin kimliği. Anahtarınız bir işletmeye bağlı değilse restaurant_id ya da restaurant_code zorunludur; bağlıysa yok sayılır. Gövde yerine sorgu dizgisinde de gönderilebilir.
restaurant_codemetinkoşullu
restaurant_id yerine işletme kodu (ör. R001). Kodu kurye firmanız verir.
latsayızorunlu
Teslimat konumu (enlem).

-90 ile 90 arası

lngsayızorunlu
Teslimat konumu (boylam).

-180 ile 180 arası

total_amountsayı
Sipariş tutarı (TL). Tutara göre değişen ücret profilleri için.

En az 0 · Varsayılan: 0

Örnek istek

curl -X POST "https://kurye.firmaniz.com/api/v1/quote" \
  -H "X-Api-Key: $KURYESOFT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "lat": 40.9969,
    "lng": 29.0342,
    "total_amount": 285.5
  }'

Yanıt

200 Başarılı

Adres hizmet bölgesinde.

okmantıksal
true: sipariş gönderilebilir.
distance_mtam sayı · boş olabilir
Yol mesafesi (metre).
duration_stam sayı · boş olabilir
Tahmini yol süresi (saniye).
delivery_feesayı
Teslimat ücreti (TL). İşletmenin ücretleri görmesi kapalıysa yer almaz.
200 · application/json
{
  "ok": true,
  "distance_m": 1754,
  "duration_s": 253,
  "delivery_fee": 70
}

200 Hizmet dışı

Adres en fazla teslimat mesafesinin ya da hizmet bölgesinin dışında.

okmantıksal
false.
messagemetin
Sebep; müşteriye gösterilebilir.
200 · application/json
{
  "ok": false,
  "message": "Adres en fazla teslimat mesafesinin (8 km) dışında"
}

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):

API_KEY_REQUIRED
HTTP:401
Anlamı:İstekte API anahtarı yok ya da ks_ ile başlamıyor.
API_KEY_INVALID
HTTP:401
Anlamı:Anahtar yanlış, silinmiş ya da pasif.
VALIDATION
HTTP:422
Anlamı:Eksik ya da hatalı alan. Hangi alanın neden reddedildiği fields içinde yazar.
NOT_FOUND
HTTP:404
Anlamı:Sipariş ya da işletme bulunamadı. Anahtarınızın göremediği bir işletmenin siparişi de böyle görünür.
İpucu:

429 RATE_LIMITED ve 5xx yanıtlarında kısa bir beklemeyle yeniden deneyin. Bkz. Yeniden deneme.