REST API v2.0

API Dokümantasyonu

KargoSeç API ile kargo fiyat karşılaştırma, gönderi oluşturma ve takip işlemlerini uygulamanıza entegre edin.

API Anahtarı Gerekli

API'yi kullanmak için önce ücretsiz hesap oluşturun, ardından giriş yaparak API Anahtarları panelinden anahtarınızı alın.

Başlarken

Kargo Seç API v2, kargo fiyat karşılaştırma ve gönderi oluşturma işlemlerini programatik olarak yapmanızı sağlar. Tüm istekler https://kargosec.com/api/v2 base URL üzerinden yapılır.

Base URL

https://kargosec.com/api/v2

Format

JSON (application/json)

Kimlik Doğrulama

Tüm API isteklerinde X-Api-Key header'ı göndermeniz gerekir. API anahtarınızı giriş yapıp API Anahtarları panelinden alabilirsiniz.

curl -X GET "https://kargosec.com/api/v2/account/info" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Accept: application/json"

Önemli: API anahtarınızı gizli tutun. Asla istemci tarafı kodda (JavaScript, mobil uygulama) kullanmayın.

İstek Limiti

Varsayılan olarak dakikada 60 istek yapabilirsiniz. Bu limit hesabınıza göre özelleştirilebilir. Limit aşıldığında 429 Too Many Requests yanıtı döner.

Endpoint'ler

Hesap

GET /api/v2/account/info

Hesap bilgisi ve bakiye sorgula

GET /api/v2/account/transactions

Bakiye hareketleri listesi. Parametreler: type, date_from, date_to, per_page

Lokasyonlar

GET /api/v2/locations/provinces

Türkiye'deki tüm illeri listele

GET /api/v2/locations/districts/{province_id}

Belirtilen ile ait ilçeleri listele

GET /api/v2/cargo-companies

Aktif kargo firmalarını listele

Fiyat Hesaplama

POST /api/v2/prices/compare

Tüm kargo firmalarından fiyat karşılaştırması yap (indirimli fiyatlar hesaplanır)

{
  "shipment_type": "koli",
  "from_province_id": 34,
  "from_district_id": 450,
  "to_province_id": 6,
  "to_district_id": 780,
  "weight": 5,
  "width": 30,
  "length": 40,
  "height": 20
}
POST /api/v2/prices/calculate

Belirli bir kargo firması için fiyat hesapla. Ek parametre: cargo_company_id

Gönderiler

POST /api/v2/shipments

Yeni gönderi oluştur (bakiyeden otomatik düşülür)

{
  "cargo_company_id": 1,
  "shipment_type": "koli",
  "sender_name": "Ali Veli",
  "sender_phone": "05551234567",
  "sender_address": "Atatürk Cad. No:1",
  "sender_province_id": 34,
  "sender_district_id": 450,
  "receiver_name": "Ayşe Fatma",
  "receiver_phone": "05559876543",
  "receiver_address": "İstiklal Cad. No:2",
  "receiver_province_id": 6,
  "receiver_district_id": 780,
  "weight": 5,
  "width": 30,
  "length": 40,
  "height": 20,
  "quantity": 1,
  "content_description": "Elektronik parçalar"
}
GET /api/v2/shipments

Gönderileri listele. Filtreler: status, tracking_number, date_from, date_to, per_page

GET /api/v2/shipments/{id}

Gönderi detayı

POST /api/v2/shipments/{id}/cancel

Gönderiyi iptal et (bakiye iade edilir)

GET /api/v2/shipments/{id}/track

Gönderi takip bilgisi

GET /api/v2/shipments/{id}/label

Etiket PDF URL'i

Hata Kodları

Kod Durum Açıklama
400Bad RequestGeçersiz istek parametreleri
401UnauthorizedEksik veya geçersiz API anahtarı
402Payment RequiredYetersiz bakiye
403ForbiddenHesap devre dışı veya IP kısıtlaması
404Not FoundKaynak bulunamadı
422Validation ErrorValidasyon hatası
429Too Many Requestsİstek limiti aşıldı
500Server ErrorSunucu hatası

Yanıt Formatı

Tüm yanıtlar aşağıdaki yapıdadır:

{
  "success": true,
  "message": "İşlem başarılı",
  "data": { ... },
  "meta": {
    "current_page": 1,
    "last_page": 5,
    "per_page": 20,
    "total": 100
  }
}

Hazır Entegrasyonlar

WooCommerce, Shopify, Trendyol ve 36+ platform için hazır entegrasyon modüllerimizi inceleyin.

Entegrasyon Merkezini Keşfet