Güncel entegrasyon rehberi

İDİS Platform Dokümantasyonu

API erişimi, SAP entegrasyonu, telefon agentı, güvenlik modeli ve operasyon akışları için merkezi başlangıç noktası. Canlı endpoint sözleşmesi her zaman OpenAPI şemasından gelir.

Swagger UI

Endpointleri inceleyin ve yetkili istekleri deneyin.

ReDoc

Okuma odaklı, ayrıntılı API referansını açın.

OpenAPI JSON

SDK, Postman ve otomasyon araçları için canlı şema.

Başlangıç

Tüm servis endpointleri aşağıdaki sürümlü base URL altında sunulur.

https://api.idis.dataliva.com/api/v1

Production API

api.idis.dataliva.com

Agent WebSocket

wss://api.idis.dataliva.com/agent-bridge

Sözleşme

OpenAPI 3.x

Kimlik doğrulama

İnsan kullanıcılar JWT Bearer token, SAP ve diğer servisler API key kullanır. Anahtarın açık değeri yalnızca üretildiği anda gösterilir; loglara veya audit kayıtlarına yazılmaz.

JWT

Authorization: Bearer <access_token>

Servis anahtarı

X-API-Key: <api_key>

Üretim kuralı: Token ve API key değerlerini URL, log, ekran görüntüsü veya destek mesajında paylaşmayın.

Ana operasyonlar

POST/mobile/rebar-bundles/batch-verify

Mal kabul

Bağ kodlarını doğrular ve çevrimiçi telefon agent'ı üzerinden kabul işlemini yürütür.

POST/mobile/rebar-bundles/batch-dispatch-complete

Sevk ve SE numarası

Envanter kontrolü, bağ yükleme, sevk onayı ve SE numarası üretimini tek akışta tamamlar.

GET/dispatches/{dispatch_id}

Sevk detayı

SE numarası, plaka, durum, kalemler ve irsaliye bilgisini döndürür.

POST/dispatches/{dispatch_id}/delivery-info

İrsaliye belgesi

Resmi PDF ve opsiyonel irsaliye numarasını tamamlanan sevke ekler.

API kapsamı

Kimlik ve erişim

JWT kullanıcı oturumu, servis API anahtarları, kullanıcı ve rol yönetimi.

Tenant yönetimi

Tenant, tenant kullanıcıları ve tenant kapsamlı sistem ayarları.

İDİS operasyonları

Envanter, mal kabul, bağ yükleme, sevk, toplu sevk ve stok beyanı.

Agent ve tarayıcı eklentisi

Cihaz eşleştirme, WebSocket agent köprüsü ve güvenli portal oturum aktarımı.

İrsaliye

Dosya yükleme, doğrulama, mal kabul ve sevk bildirimi iş akışları.

Log ve audit

Tenant kapsamlı execution logları, yönetim audit kayıtları ve özet metrikler.

Güvenlik ve tenant izolasyonu

Yetkilendirme backend tarafında uygulanır; frontend görünürlüğü tek başına güvenlik sınırı değildir.
Superadmin platform kapsamına, tenant admin yalnızca kendi tenant verisine erişebilir.
Password, token, cookie, API key ve connection string değerleri recursive olarak maskelenir.

Hata yönetimi ve istek takibi

Her response bir X-Request-ID içerir. Destek veya audit incelemesinde credential yerine bu kimliği paylaşın. Tekrarlanabilir mutasyonlarda Idempotency-Key kullanın.

Kod	Anlam	Aksiyon
400/422	Geçersiz istek veya doğrulama hatası	Request alanlarını OpenAPI şemasıyla karşılaştırın.
401	Kimlik veya agent oturumu eksik/geçersiz	Token, API key veya cihaz bağlantısını yenileyin.
403	Rol ya da tenant kapsamı yetersiz	Yetki ve tenant atamasını kontrol edin.
409	İşlem mevcut durumla çakışıyor	Response detail ve güncel kayıt durumunu inceleyin.
429	Hız sınırı aşıldı	Retry-After/backoff uygulayın.
500/503	Servis veya bağımlılık geçici olarak hazır değil	X-Request-ID ile teknik logu eşleştirin.

Canlı API referansına geçin

Endpoint parametreleri ve response modelleri için Swagger veya ReDoc sayfasını açın.

ReDoc Swagger