Quatlas Entegrasyon API'si

Entegrasyon API’si kendi sistemlerinizi (bir ERP, eBA gibi bir BPM aracı ya da bir betik) Quatlas’a bağlar. Sisteminiz taşıma talebi açar, talebi pazar yerinde ve operasyonda izler, şirketinizin taraf olduğu anlaşmaları okur ve olup biteni imzalı webhook’larla öğrenir.

Bugün neler yapabilirsiniz

• Taşıma talebi oluşturma: sisteminizdeki bir kayıttan taslak ya da yayında bir talep açın. Kaydın sizdeki numarası externalReference alanına yazılır; aynı numara ikinci bir talep açmaz.
• Talebi güncelleme ve iptal: yalnız API ile açılan taleplerde, uygulamanın kurallarının izin verdiği yerde; yayındaki talebin ilanı ve verilmeden önce iptal. Bkz. Güncelleme ve iptal.
• Kendi alanlarınız: talep üzerinde masraf merkezi, sipariş ya da süreç numarası gibi alanları metadata olarak tutun; yalnız şirketiniz görür.
• Talep okuma: kimliğiyle ya da kendi externalReference numaranızla; durumunu, açık teklif sayısını (yalnız sayı), uygulama gösterdiği andan itibaren kazanan taşıyıcıyı, anlaşmayı ve operasyon durumunu okuyun.
• Anlaşma okuma: şirketinizin taraf olduğu anlaşmaları, uygulamada gördüğünüz kadarıyla: anlaşılan fiyat, Incoterm, karşı taraf, aşama, belgeler (temiz taranmış dosya için kısa ömürlü indirme bağlantısı), kilometre taşları ve tahmini teslim, ek maliyetler ve hesap özeti toplamları.
• Belge yükleme: fatura, çeki listesi, taşıma belgesi gibi belgeleri uygulamanın yükleme kuralları, virüs taraması ve tarafınıza sunduğu kategorilerle anlaşmaya yükleyin. Bkz. Belge yükleme.
• Olayları dinleme: imzalı webhook’larla talep yayınlandığında, güncellendiğinde ya da iptal edildiğinde, teklif geldiğinde, anlaşma başladığında, kilometre taşında, teslimde, belgede, maliyette ve faturada haber alın.
• Deneme alanında test: test anahtarıyla aynı çağrıları gerçek veriye dokunmadan yapın; test talebini adım adım ilerleten bir uç nokta da var.

Sürüm 1 teklif vermez, teklif kabul etmez, kapanış odasını ya da operasyonu yürütmez, anlaşmadan çekilmez, operasyonu iptal etmez: bunlar uygulamada kalır. Talepler için liste uç noktası yoktur: talepleri tek tek, kimliğiyle ya da externalReference ile okuyun veya webhook’ları dinleyin.

Canlı ve deneme alanı

Her anahtar ya canlı ya testtir; mod anahtarın kendisindedir:

Anahtar	Başlangıcı	Çalıştığı yer	Yanıtlarda
Canlı	qk_	Şirketinizin gerçek verisi	"livemode": true
Test	qk_test_	Şirketinize ayrılmış deneme alanı	"livemode": false

İkisi de aynı adresi, rotaları, kapsamları, IP izin listesini ve hız sınırını kullanır. Test talebi pazar yerine düşmez, kimseye bildirim göndermez ve 30 gün sonra silinir. Bkz. Deneme alanı.

Bir bakışta

Temel adres	https://app.quatlasglobal.com/api/integrations/v1
Kimlik doğrulama	Authorization: Bearer qk_... ya da 15 dakikalık OAuth 2.0 erişim belirteci
Biçim	JSON (UTF-8). Yalnız belirteç isteği form-encoded. Zamanlar UTC.
Hatalar	Kararlı bir code alanıyla application/problem+json
Hız sınırı	Anahtar başına dakikada 60 çağrı (Exchange), 300 çağrı (Enterprise)
Webhook’lar	İnce gövdeli, imzalı POST (HMAC-SHA256)
OpenAPI	https://app.quatlasglobal.com/openapi/integrations-v1.json

Kim neyi kullanabilir

• Talep oluşturma yük veren (gönderici) şirketler içindir. Gönderici olmayan bir şirketin anahtarı oluşturmada 403 (Company.WrongSegment) alır.
• Anlaşma okumaları ve webhook’lar anlaşmanın iki tarafında da çalışır. Taşıyıcının anahtarı, şirketinin kazandığı anlaşmaları taşıyıcının gördüğü kadarıyla okur.
• Her okuma yalnız şirketinizin sahibi ya da tarafı olduğu kayıtlar için yanıt verir. Diğer her şey, hiç yokmuş gibi 404 döner.

Sonraki adımlar

ErişimAPI'yi kim açar, Sahip ya da Yönetici entegrasyonu nasıl oluşturur.

Hızlı başlangıçTest anahtarından deneme talebine ve ilerletmeye, curl ile.

Kimlik doğrulamaDoğrudan anahtar, OAuth 2.0 client credentials, yenileme, bitiş ve IP izin listesi.

Webhook'larOlaylar, gövdeler, imzalar, yeniden denemeler ve yeniden gönderim.

Destek

[email protected] adresine yazın. Çağrının zamanını, rotasını ve anahtarınızın önekini (qk_ ve ardından gelen 12 karakter) ekleyin. Anahtarın kendisini asla göndermeyin.