Oregon NCTS API
Dokümantasyonu
Gümrük transit işlemlerinizi kolaylaştırın. Güvenli, hızlı ve kapsamlı API ile NCTS verilerinizi yönetin.
API Referansı
Tüm API endpoint'lerin detaylı dokümantasyonu
POST
Kimlik Doğrulama
/api/v1/login
API erişimi için JWT token alın
İstek Gövdesi
{
"email": "user@example.com",
"password": "Password"
}
Yanıt
{
"token": "eyJhbGciOiJIUzI1NiJ9...",
"user_id": 78,
"expires_at": "2024-12-31T23:59:59Z"
}
POST
NCTS JSON Verisi Gönder
/api/v1/manifestos/json
JSON formatında NCTS verisi gönderin
İstek Gövdesi
{
"doc_type": "T1",
"doc_date": "2022-01-27",
"vehicle_coun": "GB",
"trailer_code": "TEST123",
"carrier_name": "TEST TRANSPORT",
"departure_custom_code": "GB000060",
"arrival_custom_code": "DE007430",
"goods_attributes": [...]
}
Yanıt
{
"status": "success",
"reference_number": "MNF230000212",
"message": "NCTS data processed successfully"
}
POST
NCTS XML Verisi Gönder
/api/v1/manifestos/xml
XML formatında NCTS verisi gönderin
İstek Gövdesi
{
"manifesto": {
"ncts_data": "<BG015B><MesSenMES3>TRA.APP</MesSenMES3>...</BG015B>"
}
}
Yanıt
{
"status": "success",
"reference_number": "MNF230000212",
"message": "NCTS data processed successfully"
}
GET
NCTS Durumu Sorgula
/api/v1/manifestos/{reference_number}
Belirli bir NCTS referans numarasının durumunu sorgulayın
Yanıt
{
"reference_number": "22TR34130001564240",
"status": "in_transit",
"current_location": "Istanbul Port",
"estimated_arrival": "2024-01-15T14:30:00Z"
}
GET
NCTS Listesi Al
/api/v1/manifestos
Tüm NCTS kayıtlarının listesini alın
Yanıt
{
"data": [
{
"reference_number": "22TR34130001564240",
"status": "in_transit",
"created_at": "2024-01-10T09:00:00Z"
}
],
"total": 1,
"page": 1
}
GET
Okunmamış Mesajları Al
/api/v1/messages/unread
Sistem tarafından gönderilen okunmamış mesajları alın
Yanıt
{
"messages": [
{
"id": 1,
"type": "status_update",
"message": "Your shipment has arrived at destination",
"created_at": "2024-01-15T10:30:00Z"
}
],
"count": 1
}
GET
PDF Döküman İndir
/api/v1/manifestos/{reference_number}/pdf
NCTS belgelerini PDF formatında indirin
Yanıt
{
"message": "PDF file download will start",
"download_url": "https://ncts.oregon.com.tr/downloads/MNF230000212.pdf"
}
Postman Koleksiyonu
API testleri için hazır Postman koleksiyonu
Oregon NCTS API Koleksiyonu
7 endpoint ile kimlik doğrulama ve örnekler
Dahil Edilen Endpoint'ler:
- Kimlik Doğrulama Token'ı Al
- NCTS JSON Verisi Gönder
- NCTS XML Verisi Gönder
- NCTS Durumu Al
- NCTS Listesi Al
- Okunmamış Mesajları Al
- PDF Döküman Al
Kullanım Talimatları:
- Koleksiyonu Postman'a aktarın
- Önce "Kimlik Doğrulama Token'ı Al" isteğini çalıştırın
- Token otomatik olarak diğer istekler için kaydedilecek
- Kimlik doğrulamalı token ile diğer endpoint'leri test edin
Hata Kodları
API yanıtlarında karşılaşabileceğiniz HTTP durum kodları ve çözüm önerileri
200
OK
İstek başarıyla işlendi
Çözüm:
Normal işlem akışı devam eder
400
Bad Request
Geçersiz istek parametreleri veya veri formatı
Çözüm:
İstek verilerini kontrol edin ve doğru format kullanın
401
Unauthorized
Geçersiz veya eksik kimlik doğrulama token'ı
Çözüm:
Giriş yapın ve geçerli bir Bearer token kullanın
404
Not Found
İstenen kaynak bulunamadı
Çözüm:
URL ve kaynak referanslarını kontrol edin
422
Unprocessable Entity
Veri formatı doğru ancak iş kurallarına uygun değil
Çözüm:
NCTS veri yapısını ve zorunlu alanları kontrol edin
429
Too Many Requests
Rate limit aşıldı
Çözüm:
İstek sıklığını azaltın ve yeniden deneyin
500
Internal Server Error
Sunucu tarafında beklenmeyen hata
Çözüm:
Daha sonra tekrar deneyin veya destek ekibiyle iletişime geçin
503
Service Unavailable
Servis geçici olarak kullanılamıyor
Çözüm:
Sistem bakımda olabilir, daha sonra tekrar deneyin