Paketleri katı bir durum makinesi üzerinden takip edin (etiket oluşturuldu → teslim alındı → yolda → teslimat için yola çıktı → teslim edildi). Okuma işlemleri herkese açıktır; her yazma işlemi için X-API-Key: cargo-key-123 başlığı gereklidir — bu, başka yerlerde kullanılan Bearer token'larından farklı bir kimlik doğrulama stilidir.
Temel URL: https://funapi.dev/api/cargo/v1 · 9 uç nokta · OpenAPI 3.1 belgesi ve Postman koleksiyonu mevcut. Yeni misiniz? Önce şunu okuyun: başlangıç rehberi.
Paketim nerede?
GET /cargo/v1/shipments — Gönderileri listele, duruma göre filtrele · Yanıt kodları: 200 400 Bu uç noktanın bağlantısıGET /cargo/v1/shipments/{id} — Bir gönderiyi takip edin · Yanıt kodları: 200 404 Bu uç noktanın bağlantısıGET /cargo/v1/shipments/{id}/events — İzleme geçmişi · Yanıt kodları: 200 404 Bu uç noktanın bağlantısıGET /cargo/v1/shipments/{id}/eta — Tahmini teslimat süresi (belirleyici mod uyumlu) · Yanıt kodları: 200 404 Bu uç noktanın bağlantısıGET /cargo/v1/rates — Ağırlığa göre nakliye fiyatı · Yanıt kodları: 200 400 Bu uç noktanın bağlantısıX-API-Key tarafından kontrol edilen yazıyor.
POST /cargo/v1/shipments — Kargo etiketi oluşturun (X-API-Key) · Yanıt kodları: 201 400 401 Bu uç noktanın bağlantısıPOST /cargo/v1/shipments/{id}/advance — Durum makinesini bir adım ilerlet (X-API-Key) · Yanıt kodları: 200 401 404 409 Bu uç noktanın bağlantısıPOST /cargo/v1/shipments/{id}/attempt-delivery — Teslimat denemesi — başarısız olabilir, 3 hata durumunda geri döner (X-API-Key) · Yanıt kodları: 200 401 404 409 Bu uç noktanın bağlantısıPUT /cargo/v1/shipments/{id}/address — Bir paketi yeniden yönlendir (X-API-Key + If-Match) · Yanıt kodları: 200 400 401 404 409 412 Bu uç noktanın bağlantısıCargo Tracking API'si, gönderi durumlarını (oluşturuldu, teslim alındı, yolda, teslim edildi) takip eden bir gönderi durum makinesidir; burada yasa dışı geçişler kabul edilmek yerine reddedilir. Ayrıca, katalogdaki yazma işlemlerini Bearer token yerine X-API-Key başlığıyla doğrulayan tek API'dir; bu da birden fazla kimlik doğrulama şemasını ele alması gereken bir istemciyi test etmek için kullanışlı hale getirir.
GET https://funapi.dev/api/cargo/v1/shipments — Gönderileri listele, duruma göre filtrele. Token yok, kayıt yok:
curl -i https://funapi.dev/api/cargo/v1/shipments
Yanıt: 200 OK
{
"total": 3,
"data": [
{
"id": "TRK123456",
"recipient": "Wile E. Coyote",
"status": "in-transit",
"attempts": 0
},
{
"id": "TRK777777",
"recipient": "Joey Tribbiani",
"status": "delivered",
"attempts": 1
},
{
"id": "TRK000001",
"recipient": "H. Potter",
"status": "label-created",
"attempts": 0
}
]
}
Son güncelleme