Entegrasyon API'si · v1
KuryeSoft Entegrasyon API'si
Nasıl çalışır
- 01API
Siparişi gönderin
Sipariş onaylandığında POS'unuz ya da siteniz
POST /ordersile siparişi kurye firmasına iletir. - 02Otomatik
Sistem kuryeyi atar
KuryeSoft yakındaki uygun kuryeyi bulur, teklifi gönderir, rotayı hesaplar. Sizin bir şey yapmanız gerekmez.
- 03Webhook
Durumu izleyin
Her durum değişikliği webhook adresinize gelir; müşteriniz takip bağlantısından kuryeyi canlı izler.
Her kurye firmasının kendi adresi
KuryeSoft her kurye firmasına ayrı kurulur; API, firmanın kendi alan adında çalışır. Taban adres firmanızın panel adresinin sonuna /api/v1 eklenerek bulunur:
https://kurye.firmaniz.com/api/v1
Adresi ve API anahtarını çalıştığınız kurye firmasından alırsınız. Üst menüdeki Sunucu adresi alanına adresinizi yazarsanız bu belgelerdeki bütün örnekler sizin adresinizle gösterilir.
Birden çok kurye firmasıyla çalışıyorsanız her firma için ayrı adres ve ayrı anahtar saklayın. Bir firmanın anahtarı başka bir firmanın sunucusunda geçerli değildir.
Uçlar
/pingAnahtarın geçerli olduğunu doğrular; anahtarın adını ve bağlı olduğu işletmeyi döndürür.GET/payment-typesKurye firmasında tanımlı etkin ödeme tipleri.GET/cancel-reasonsKurye firmasının tanımladığı hazır iptal sebepleri.POST/quoteSipariş göndermeden önce adresin hizmet bölgesinde olup olmadığını, mesafeyi ve teslimat ücretini öğrenin.POST/ordersKurye firmasına yeni bir paket siparişi gönderir; sistem uygun kuryeyi kendisi atar.GET/orders/{ref}Siparişin güncel durumu, kurye bilgisi, tahmini teslim zamanı ve takip bağlantısı.POST/orders/{ref}/readyPaketin hazır olduğunu bildirir; atanmış kuryeye bildirim gider.POST/orders/{ref}/cancelSiparişi iptal eder; atanmış kurye varsa siparişin iptal edildiği bildirilir.Kimler için
- POS ve adisyon yazılımları: kasada onaylanan paket siparişi kurye firmasına düşer, "hazır" düğmesi kuryeye bildirim gönderir.
- E-ticaret siteleri: ödeme sayfasında adresin hizmet bölgesinde olup olmadığını ve teslimat ücretini gösterir, sipariş onaylanınca gönderir.
- Kendi sipariş sistemi olan işletmeler ve iş ortakları: zincir restoranlar, çağrı merkezleri, toplu sipariş yazılımları.
Yemek platformları ve bazı POS sistemleri için kurye firmasının panelinde hazır entegrasyonlar vardır; onlar için kod yazmanız gerekmez. Bu belgeler kendi yazılımınızı bağlamak içindir.
Makine tarafından okunabilir tanım
API'nin tamamı OpenAPI 3.1 biçiminde /openapi.json adresinde. Postman'a, Insomnia'ya ya da kod üreticinize aktarabilirsiniz; ayrıntı OpenAPI ve Postman sayfasında.