İçeriğe geç
SEVKORA API POST /api/v1/carrier-accounts v1 Değişiklikler

Public API v1 sözleşmesi Taşıyıcı hesapları PA-57

Kendi-hesap satırı açma

POST/api/v1/carrier-accounts

> Künye: TASK-417; REQ-023 AC-6, DEC-364, RISK-098.

Amaç

Tenant'ın kendi taşıyıcı kimliğini (bugün yalnız MNG) Sevkora'ya kaydetmek. Satır verification_status=pending doğar: doğrulanmamış kimlik hiçbir sevk yolunda kullanılmaz; sevk edilebilir olması için PA-59 ile doğrulanması gerekir.

Yetki

Bearer anahtar; kapsam anahtarın tenant'ıdır.

Gövde

carrier_code (yalnız kendi-hesap modeline açık taşıyıcı kodu; bugün mng, başkası 422 errors.carrier_code), name, environment (sandbox ya da live; zorunlu), confirm_live (canlı ortam için true; sandbox'ta gönderilmez), credentials (dört alan birlikte: clientId, clientSecret, customerNumber yalnız rakam, password).

GİZLİ ALANLAR YALNIZ YAZILIR

Dört değer istekte alınır, hiçbir yanıtta geri dönmez. Yanıtta kimlikten türeyen tek parça credential_fingerprint alanıdır: müşteri numarasının son dört hanesi.

Kurallar

aynı taşıyıcı ve ortam için ikinci aktif satır 422 errors.carrier_code; aynı ad 422 errors.name; eksik ya da biçimsiz kimlik alanı alan ADIYLA 422 (hata mesajı değer taşımaz).

Yan etkiler

her başarılı yazma denetim defterine bir satır bırakır ve hesabın tüm üyelerine uygulama içi ve e-posta bildirimi gider. Bildirim isteği atan anahtarın sahibine de gider; ele geçirilmiş bir anahtarla yapılan değişiklik, hesabın diğer üyelerinin göreceği bir kanaldan duyurulur.

Başarı 201

{"data": hesap}; hesap nesnesi PA-12 satırıyla aynıdır.

Hatalar

401, 422, 429.

Idempotency-Key

sözleşmesi yoktur; aynı ad ikinci kez 422 döner.

kabuk
curl -X POST "{{base_url}}/carrier-accounts" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer SEVKORA_API_ANAHTARINIZ" \
  -d '{"carrier_code":"mng","name":"MNG hesabim","environment":"sandbox","credentials":{"clientId":"TASIYICI_CLIENT_ID","clientSecret":"TASIYICI_CLIENT_SECRET","customerNumber":"1234567890","password":"TASIYICI_MUSTERI_PAROLASI"}}'