Ana içeriğe geç

Kargo Entegrator API'ye Hoş Geldiniz

Kargo Entegrator API, kargo gönderilerinizi oluşturmanız, takip etmeniz ve iadeleri yönetmeniz için REST tabanlı bir arayüz sunar. Bu dokümantasyon, API'yi hızlıca entegre etmeniz için hazırlanmıştır.

Uygulamanın çalışma mantığı​

Kargo Entegrator’da iş akışı şöyledir:

  1. Kargo entegrasyon hesabı ve depo eklenir — Panelden en az bir kargo entegrasyonu ve bir depo adresi tanımlanır; gönderi oluştururken bu kayıtların ID’leri kullanılır.
  2. PDF çıktı ayarları — Etiket/barkod PDF’inin nasıl görüneceği, uygulama (app) üzerinden yapılandırılır.
  3. Gönderi oluşturulur — API veya panel üzerinden gönderi isteği oluşturulur; kargo firmalarına teslim için PDF çıktı alınır.
  4. Oluşturulan gönderi kargo firmasına teslim edilir — Paket fiziksel olarak kargo firmasına teslim edilir. Bu aşamayı denemek için gerçek kargo kullanmadan Dummy Kargo ile test gönderisi oluşturabilirsiniz.
  5. Gönderi durumları takip edilir — Kargo firmasından gelen durum güncellemeleri (kabul edildi, şubede, dağıtımda, teslim edildi vb.) webhook ile alınır. Gönderi oluştururken notification_url belirtmeniz gerekir; durumlar bu URL’ye bildirilir.

Webhook’u test etmek için aşağıdaki Test ortamı: Dummy Kargo bölümüne göre Dummy Kargo ile deneyebilirsiniz.

Adım adım başlarken​

API’yi kullanmaya başlamak için sırasıyla şunları yapın:

1. Hesap ve API anahtarı​

  • app.kargoentegrator.com adresinden hesap oluşturun.
  • Panelden API anahtarınızı alın. Tüm API isteklerinde bu anahtar kullanılır (bkz. Kimlik Doğrulama).
  • API istekleri için base URL: https://app.kargoentegrator.com/api

2. Panelden gerekli ayarlar​

Gönderi veya iade oluşturmadan önce panelde şu iki ayarın yapılmış olması gerekir:

AyarNeden gerekliID’yi nereden alırsınız?
Kargo entegrasyonu (en az 1 adet)İsteklerde cargo_integration_id kullanılır.Kargo entegrasyonları → İlgili hesaba tıklayın → Sağ taraftan ID’yi alın.
Depo adresi (en az 1 adet)İsteklerde warehouse_id kullanılır.Depo adresleri → İlgili depoya tıklayın → Sağ taraftan ID’yi alın.

Bu ayarlar yapılmadan gönderi/iade oluşturma istekleri başarılı olmaz.

Test ortamı: Dummy Kargo​

Webhook ve durum güncellemelerini gerçek kargo kullanmadan denemek için Dummy Kargo entegrasyonunu kullanabilirsiniz:

  • Kota düşmez — Dummy Kargo ile oluşturulan gönderiler gönderi hakkınızdan düşmez.
  • Durum değiştirme — Panelde Gönderiler bölümünden bu gönderilerin durumunu manuel değiştirebilirsiniz.
  • Webhook testi — Durum değişince notification_url adresinize istek gider; böylece webhook akışını gerçek gönderi açmadan test edebilirsiniz.

Gönderi oluştururken notification_url tanımlamanız gerekir; kargo firmasından gelen güncellemeler bu URL’ye bildirilir.

Postman ile deneyin​

API’yi hızlıca denemek için:

Kargo Entegratör API — Postman Dokümantasyonu

Collection’ı import ettikten sonra ortam değişkenlerinde:

  • url: https://app.kargoentegrator.com/api
  • api_key: Panelden aldığınız API anahtarı

Destek​

Destek için bizimle iletişime geçin

API entegrasyonunuz sırasında sorularınız olursa veya teknik destek almak isterseniz, ekibimiz size yardımcı olmaktan mutluluk duyar. [email protected] adresine e-posta göndererek bizimle iletişime geçebilirsiniz; talebinizi en kısa sürede yanıtlamaya özen gösteriyoruz.

Sonraki Adım​

Kimlik Doğrulama sayfasından API isteklerinde kullanacağınız yetkilendirme yöntemini inceleyin.