Ana içeriğe atla
Her yanıt sonucu iki katmanda bildirir:
  • HTTP durum kodu hatanın türünü söyler: istek hatalı mı (400), yetki mi yok (403), kayıt mı yok (404)?
  • ResultCode hatanın tam olarak ne olduğunu söyler: ör. 1002 cari kodu zaten kullanılıyor. Tüm kodlar Sonuç kodları sayfasındadır.

Hata yanıtı

boolean
Hatalarda false.
string
Başarılı yanıtlarda 0000. Hatalarda ilk hatanın kodu.
string
Tüm hata mesajları, boşlukla ayrılmış tek metin (İngilizce).
array
Her hata için Code ve Message. Sadece hatalarda döner.
string
Yalnızca mükerrer kayıt hatalarında (benzersiz olması gereken bir değer zaten kullanılıyor; ör. cari kodu 1002, ürün kodu 2002, belge ve fiş numaraları, tanım adları): var olan kaydın ID’si; yeni kayıt açmak yerine bunu kullanabilirsiniz.
string
Yalnızca 500 yanıtlarında (0001). Hatanın bulunabilmesi için bu değeri Noyax destek ekibine iletin.
Bir istekte birden fazla doğrulama hatası varsa hepsi tek yanıtta döner. Bu durumda ResultCode ilk hatanın kodudur; belirli bir hatayı ararken Errors listesine bakın.
Mükerrer kayıt hatası şöyle görünür:
Entegrasyon mantığınızı Message metnine değil Code değerine dayandırın. Mesaj metinleri iyileştirilebilir, kodların anlamı ise değişmez.

HTTP durum kodları

Kontrol sırası

Bir istekte farklı aşamalarda sorun varsa ilk aşamanın hataları döner. Kontroller şu sırayla yapılır:
1

Token (401)

Token var mı, imzası ve süresi geçerli mi?
2

Header'lar (400)

X-UserID, X-CompanyID, X-PeriodID geçerli mi, kullanıcı şirkete tanımlı mı?
3

Yetki (403)

Anahtarın modülde gereken okuma ya da yazma yetkisi var mı?
4

İstek limitleri (429)

Saniyedeki ya da günlük istek limiti aşıldı mı?
5

Gövde biçimi (400)

JSON gövdesi okunabiliyor mu?
6

İş kuralları (400 / 404)

Alanlar geçerli mi, kayıt var ve görülebilir mi?

Gövde biçim hataları

JSON gövdesi okunamıyorsa (bozuk JSON, tarih alanına geçersiz değer, sayı alanına metin gibi) 400 ve 0002 kodu döner. Mesaj, hatalı alanın JSON yolunu içerir:

Bilinmeyen alanlar

İstek gövdesi yalnızca endpoint’in istek şemasındaki alanları içerebilir. Endpoint’te olmayan bir üst seviye alan adı (yazım hatası, alanın ad aldığı yerde GroupDetailId1 gibi bir ID, o kaynakta güncellenemeyen bir alan) POST, PUT ve PATCH’te 400 ve 0002 koduyla reddedilir; sessizce yok sayılmaz. Adlar büyük/küçük harfe duyarsız karşılaştırılır. Bu yüzden, istekte bulunmayan alanlar içeren bir yanıt gövdesi olduğu gibi PUT gövdesi olarak geri gönderilemez; yalnızca istek alanlarını gönderin.

Hataları ele almak

Yalnızca 401 (token yenileme sonrası), 429 (saniye limitinde bir saniye sonra, günlük limitte ertesi gün) ve 500 yanıtlarını tekrar deneyin. 400, 403 ve 404 yanıtları istek değişmeden tekrarlandığında aynı sonucu verir.