Skip to content

Postman koleksiyonu

Her uç nokta için bir istek içeren, çalışmaya hazır bir koleksiyon. İstekler gerçek bir entegrasyonun izlediği sırayla dizilmiştir ve birlikte çalıştırıldığında kimlik bilgisinden iptal edilmiş teslimata kadar olan akışın tamamını kapsar. Her istek kendi doğrulamalarını taşıdığı için başarılı bir koşu, çalıştığının kanıtıdır.

Koleksiyonu indir

Dosyayı Postman'de File → Import menüsünden içeri aktarın.

Kurulum

İki değişkenin tanımlanması yeterlidir; her ikisi de entegrasyon başvurunuz onaylandığında verilir:

DeğişkenKaynağı
clientIdOnay e-postanızda yer alır. Gizli bilgi değildir.
clientSecretOnay e-postanızda hzl_test_ ön ekiyle yer alır. Başka hiçbir yerde saklanmaz; kaybedilmesi hâlinde yenisi talep edilmelidir.

baseUrl varsayılan olarak test ortamına tanımlıdır. Diğer değişkenler koşu sırasında kendiliğinden dolar: token isteği erişim token'ını, mağaza kaydı kurye şirketi kimliğini, sipariş oluşturma ise sipariş kimliğini saklar.

Yalnızca test anahtarıyla çalıştırın

Bu koleksiyonu hzl_live_ anahtarıyla çalıştırmayın. Canlı ortamda oluşturulan sipariş gerçek bir kurye görevlendirir ve kurye şirketine faturalandırılır.

İçerik

SıraİstekKapsam
1POST /tokenKimlik bilgilerini bir saat geçerli token'a dönüştürür
2PUT /stores/{externalStoreId}Mağazayı kaydeder ve hizmet veren kurye şirketlerini listeler
3PUT /stores/{externalStoreId}Seçilen kurye şirketini mağazaya bağlar
4POST /ordersTeslimat isteği oluşturur
5GET /orders/{orderId}Güncel durumu ve olay geçmişini döndürür
6POST /orders/{orderId}/cancelTeslimatı iptal eder

İstekleri yukarıdan aşağıya sırayla çalıştırın. Her istek bir sonrakinin gereksinim duyduğu değeri üretir: mağaza oluşturulmadan sipariş gönderilemez, sipariş oluşturulmadan sorgulanamaz ve iptal edilemez.

İkinci ve üçüncü istek aynı uç noktayı kullanır. Bu, kurye şirketi seçiminin ayrı bir uç nokta gerektirmediğini gösterir: ilk çağrı fleetId alanı olmadan gönderilir ve hizmet veren şirketleri listeler, ikinci çağrı seçilen şirketi bağlar.

Hata kodlarının ve test ortamı senaryolarının tamamı koleksiyonun kapsamı dışındadır. Bunlar Hatalar ve Test ortamı sayfalarında, tetikleme koşullarıyla birlikte belgelenmiştir.

Öne çıkan doğrulamalar

Bazı testler, gözle kolayca gözden kaçabilecek noktaları denetler:

  • Erişim token'ı çözümlenerek rol claim'i taşımadığı doğrulanır. Rol claim'i taşıması hâlinde, taşımaması gereken bir uç noktada rol denetiminden geçme ihtimali doğardı.
  • Kurye şirketi listesi sızan iletişim bilgisine karşı taranır; telefon, e-posta, vergi numarası ve poligon bilgisi yanıtta yer almamalıdır.
  • İptal isteği hem 200 hem 409 CANCEL_TOO_LATE yanıtını doğru kabul eder. Test ortamında paket 30. saniyede teslim alınır; bu saniyeden sonra çalıştırılan iptal isteğinin reddedilmesi beklenen davranıştır.

Tek kaynak

Koleksiyon OpenAPI tanımına göre üretilmektedir. İkisi arasında bir tutarsızlık bulunması hâlinde tanım esas alınır. Böyle bir durumu tarafımıza bildirmenizi rica ederiz; tutarsızlık bizim tarafımızdaki bir hataya işaret eder.

Hızlıyo Vendor API v1