Referanslar API'si Yanıt Kodları

Şunlar için geçerlidir: İş Ortağı Merkezi | İş Ortağı Merkezi Referansları

Uygun roller: Referans yöneticisi | Referans kullanıcısı

İş Ortağı Merkezi Referansları REST API'leri, durum kodu içeren bir JSON nesnesi döndürür. İsteğinizin başarılı olup olmadığını veya neden başarısız olduğunu gösteren bu kod.

Başarılı yanıtlar

2xx durum kodu, istemcinin isteğinin başarıyla alındığını, anlaşıldığını ve kabul edildiğine işaret eder. Aşağıdaki 2xx durum kodları bir başarı yanıtı gösterir:

• 200: Başarı onaylandı
• 201: Kaynak oluşturuldu
• 202: Kabul Edildi
• 204: Döndürülecek içerik yok

Hata yanıtları

4xx veya 5xx durum kodu içeren herhangi bir yanıt, bu kodun hata koşullarıyla ilgili ayrıntıları içeren bir hata iletisi içerir.

Aşağıdaki tabloda hata senaryoları için döndürülebilecek HTTP durum kodları listelenmektedir ve açıklanmaktadır.

Durum kodu	Durum iletisi	Açıklama
400	Hatalı İstek	Yanlış biçimlendirilmiş veya yanlış olduğundan istek işlenemiyor.
401	Yetkisiz	Gerekli kimlik doğrulama bilgileri eksik veya kaynak için geçerli değil.
403	Yasak	İstenen kaynağa erişim reddedildi. Kullanıcının yeterli izni olmayabilir.
404	Bulunamadı	İstenen kaynak yok.
405	Yönteme İzin Verilmiyor	İstekteki HTTP yöntemine kaynak üzerinde izin verilmez.
406	Kabul Edilemez	Bu hizmet, Accept üst bilgisinde istenen biçimi desteklemiyor.
409	Çakışma	Geçerli durum, isteğin beklediğiyle çelişiyor. Örneğin, belirtilen üst klasör mevcut olmayabilir.
410	Gitmiş	İstenen kaynak artık sunucuda yok.
411	Uzunluk Gerekli	İstekte Content-Length başlığı gereklidir.
412	Önkoşul Başarısız Oldu	İstekte sağlanan önkoşul (if-match üst bilgisi gibi) kaynağın geçerli durumuyla eşleşmiyor.
413	İstek Birimi Çok Büyük	İstek boyutu üst sınırı aşıyor.
415	Desteklenmeyen Medya Türü	İsteğin içerik türü, hizmetin desteklemediği bir biçimdir.
416	İstenen Aralık Karşılanabilir Değil	Belirtilen bayt aralığı geçersiz veya kullanılamıyor.
422	İşlenemeyen Varlık	Sembolik olarak yanlış olduğundan istek işlenemiyor.
423	Kilitli	Erişilmekte olan kaynak kilitli.
429	Çok Fazla İstek Var	İstemci uygulaması kısıtlandı ve isteği bir süre yinelemeye çalışmamalıdır.
500	İç Sunucu Hatası	İstek işlenirken bir iç sunucu hatası oluştu.
501	Uygulanmadı	İstenen özellik uygulanmadı.
503	Hizmet Kullanılamıyor	Hizmet bakım için geçici olarak kullanılamıyor veya aşırı yüklenmiş. Bir gecikmeden sonra isteği yineleyebilirsiniz; uzunluğu Yeniden Deneme Sonrası üst bilgisinde belirtilebilir.
504	Ağ Geçidi Zaman Aşımı	Sunucu, ara sunucu görevi görürken, isteği tamamlamaya çalışırken erişmek için gereken yukarı akış sunucusundan zamanında yanıt almadı. 503 ile birlikte oluşabilir.
507	Yetersiz Depolama	Depolama kotası üst sınırına ulaşıldı.
509	Bant Genişliği Sınırı Aşıldı	İstemci uygulaması, bant genişliği üst sınırını aştığı için kısıtlandı. Uygulamanız bir süre sonra isteği yeniden deneyebilir.

Hata kaynak türü

Hata yanıtı, error adlı tek bir özellik içeren tek bir JSON nesnesidir. Bu nesne hatanın tüm ayrıntılarını içerir. HTTP durum kodu yerine veya buna ek olarak burada döndürülen bilgileri kullanabilirsiniz.

Aşağıdaki tablo ve kod örnekleri bir hata yanıtının şemasını açıklar.

Adı	Tür	Açıklama
kod	Dizgi	Her zaman geri döndü. Oluşan hata türünü gösterir. Null olmayan.
ileti	Dize	Her zaman geri döndü. Hatayı ayrıntılı olarak açıklar ve daha fazla hata ayıklama bilgisi sağlar. Null olmayan boş değer yok. Uzunluk üst sınırı 1.024 karakterdir.
iç hata	nesne	isteğe bağlı. Hatayla ilgili daha ayrıntılı bilgiler içeren başka bir hata nesnesi oluştu.
innerError.code	sayısal dize	innerError null değilse her zaman döndürülür. En yüksek hata kodu değerinin altında daha özel hata kodu bilgileri sağlar.
innerError.message	Dize	innerError null değilse her zaman döndürülür. Üstteki hata iletisi dizesinin altında daha belirgin bir hata iletisi sağlar.
içHata.detaylar	dizi nesnesi	isteğe bağlı. Hata hakkında daha fazla ayrıntı içerir. Giriş doğrulama hatalarında öncelikli olarak yararlıdır.
hedef	Dizgi	isteğe bağlı. Hatanın kaynaklandığı hedef.

Örnek hata yanıtı

{
  "error": {
    "code": "unauthenticated",
    "message": "The caller is not authenticated.",
    "innerError": {
      "code": "99902",
      "message": "Request not authenticated",
      "details": null
    }
  }
}

innerError.details nesnesi doldurulmuş başka bir örnek:

{
  "error": {
    "code": "invalidRequest",
    "message": "The request is malformed or incorrect.",
    "innerError": {
      "code": "99901",
      "message": "InvalidInput",
      "details": [
        {
          "InvalidReferralForCoSellConversion": [
            "If PartnerLed referral has no solution it cannot be converted to co-sell referral"
          ]
        }
      ]
    }
  }
}

Kod özelliği

code özelliği aşağıdaki olası değerlerden birini içerir. Uygulamalarınız bu hatalardan herhangi birini işlemeye hazır olmalıdır.

Kod	Http durum kodu	Açıklama
invalidRequest	400	İstek yanlış biçimlendirilmiş veya yanlış.
Kimliği_doğrulanmamış	401	Arayan kimliği doğrulanmamış.
accessDenied	403 - Yasaklı (Forbidden)	Çağıranın eylemi gerçekleştirme izni yok.
itemNotFound	404	Kaynak bulunamadı.
kaynakGüncellendi	409	Güncellenen kaynak, çağıranın son okumasından bu yana değiştirildi; genellikle bu bir eTag uyuşmazlığıdır.
önkoşulBaşarısız	412	İstekte sağlanan önkoşul (if-match üst bilgisi gibi) kaynağın geçerli durumuyla eşleşmiyor.
generalException	500	Belirtilmeyen bir hata oluştu.
serviceNotAvailable	503	Hizmet kullanılamıyor. Gecikmeden sonra isteği yeniden deneyin. "Retry-After üst bilgisi olabilir."

İleti özelliği

message Kök özelliği, geliştiricinin okuması için tasarlanmış bir hata iletisi içerir. Hata iletileri yerelleştirilmemiştir ve doğrudan kullanıcıya görüntülenmemelidir. Kodunuz yalnızca message değerlerini denetlememelidir, çünkü bunlar herhangi bir zamanda değişebilir ve genellikle başarısız isteğe özgü dinamik bilgiler içerebilir. size code özelliklerinde döndürülen hata kodlarına karşı kod yazmanız ve daha fazla ayrıntı için bunu mesaj metniyle birleştirmeniz gerekir.

InnerError nesnesi

innererror Nesne özyinelemeli olarak daha belirli hata kodları içeren daha fazla innererror nesne içerebilir. İstemci uygulaması, bir hatayı işlerken kullanılabilir tüm hata kodları arasında döngü yapmalı ve anladıkları en ayrıntılı kodu kullanmalıdır.

Uygulamanızın iç içe innererror nesneler içinde karşılaşabileceği bazı hatalar daha vardır. Uygulamalar bu hataları işlemek için gerekli değildir, ancak tercih ederlerse bunu yapabilir. Hizmet herhangi bir zamanda yeni hata kodları ekleyebilir veya eskilerini döndürmeyi durdurabilir, bu nedenle tüm uygulamaların [temel hata kodları] işleyebilmesi önemlidir.

Hata kodları

API'ler tarafından döndürülen hata kodları şunlardır:

HTTP Durumu	HTTP Hata Kodu	Hata kodu	Açıklama
Geçersiz İstek	400	99901	Geçersiz giriş
Yetkisiz	401	99902	Yetkisiz erişim
Kötü İstek	400	99903	Eksik giriş
Bulunamadı	404	99904	Kaynak bulunamadı
İç Sunucu Hatası	500	99905	Hata belirtilmedi
Çok Fazla İstek	429	99906	Çok fazla istek var
Dahili Sunucu Hatası	500	99907	Geçici iç hata
Geçersiz İstek	400	99908	Özellik güncelleştirilebilir değil
Hatalı İstek	400	99909	Özellik null olamaz
Önkoşul Başarısız	412	99910	Etag değeri eşleşmiyor
Hatalı İstek	400	99911	Davet etmek için geçersiz yönlendirme durumu
Geçersiz İstek	400	99912	'name' türüne sahip çözüm gereklidir
Yasak	403	99913	Organizasyon, kaynak oluşturmak için izin verilenler listesine alınmadı
Yasak	403	99914	Beyaz listeye alınmamış kuruluşların ortak satış faaliyetlerine katılmalarına izin verilmez
İç Sunucu Hatası	500	99915	İç istek yürütme hatası
Çakışma	409	99917	Kaynak zaten başka bir istekle değiştirildi
Ön Koşul Başarısız	412	99918	İstekte sağlanan önkoşul (if-match üst bilgisi gibi) kaynağın geçerli durumuyla eşleşmiyor.
Hatalı İstek	400	99919	Güncelleştirilecek referans niteliği geçersiz
SunucuİçiHata	500	99999	İstek işlenirken genel özel durum