Yanıt biçimi
SP-API'nin, yanıt başlıklarını ve mesajları döndürme şekli.
Satış Ortağı API'si, bir HTTP isteğine yanıt olarak yanıt başlıkları ve JSON yanıt mesajı döndürür.
Aşağıdaki tabloda alabileceğiniz yanıt başlıkları listelenmektedir. Alacağınız gerçek başlıklar, belirli API bölümüne ve işlemine bağlı olur.
Yanıt başlıkları
Ad | Açıklama | Örnek |
---|---|---|
Bağlantı | İstemciyle kesintisiz bir bağlantı için varsayılan keep-alive değeri. | Connection: keep-alive |
İçerik-Uzunluk | Standart HTTP yanıt başlığı. | Content-Length: 624 |
İçerik Türü | Standart HTTP yanıt başlığı. | Content-Type: application/json |
Tarih | Standart HTTP yanıt başlığı. | Date: Fri, 17 Feb 2023 20:13:55 GMT |
x-amz-apigw-id | APIGateway tarafından oluşturulan genişletilmiş istek kimliği. Bu başlık isteğe bağlıdır ve döndürülmeyebilir. | x-amz-apigw-id: Ac1E1EycvHcFyNw= |
x-amzn-ErrorType | Yanıt durum kodu 4xx veya 5xx ise APIGateway bu hatayı errorType ile doldurur. Bu başlık isteğe bağlıdır ve döndürülmeyebilir. | x-amzn-ErrorType: AccessDeniedException |
x-amzn-RateLimit-Limit | Returns the rate limit applied to the request. This header is returned on a best-effort basis and only for specific HTTP responses. Refer to Usage Plans and Rate Limits in the SP-API for more information. | x-amzn-RateLimit-Limit: 2.0 |
x-amzn-RequestId | İstek tanımlayıcı: Destek almak için bizimle iletişime geçerseniz bu bilgiyi sağlayın. | x-amzn-RequestId: 6875f61f-6aa1-11e8-98c6-9bExample |
X-Amzn-Trace-Id | APIGateway tarafından oluşturulan bir izleme tanımlayıcı. Bu başlık isteğe bağlıdır ve döndürülmeyebilir. | X-Amzn-Trace-Id: Root=1-63ee9bb8-52ea8e6d108209842abc2a4d |
Başarılı yanıt
Satış Ortağı API'si, isteğiniz başarılı olursa istenen verileri döndürür. Başarılı bir yanıt örneğini aşağıda bulabilirsiniz:
HTTP/1.1 200 OK
Content-Length: 368
Content-Type: application/json
Date: Thu, 01 Jun 2020 22:23:31 GMT
x-amzn-RequestId: 6875f61f-6aa1-11e8-98c6-9bExample
{
"payload": {
"ConfirmedNeedByDate": "2020-04-23",
"ConfirmedFulfillableDate": "2020-04-23"
}
}
Hata yanıtı
Satış Ortağı API'si, isteğiniz başarısız olursa hata yanıtı döndürür. Hata yanıtındaki yanıt mesajında bulunan öğeler aşağıda verilmiştir:
Yanıt mesajı
Öğe | Açıklama | Zorunlu mu? |
---|---|---|
code | HTTP durum kodu. | Evet |
message | Hata durumunun açıklaması. | Evet |
details | Ek bilgilerin bağlantısı. | Hayır |
Hata yanıtının bir örneğini aşağıda bulabilirsiniz:
HTTP/1.1 400 Bad Request
Content-Length: 117
Content-Type: application/json
Date: Fri, 01 Jun 2020 21:48:02 GMT
x-amzn-ErrorType: ValidationException
x-amzn-RequestId: a8c8d99a-6ab5-11e8-b0f8-19363980175b
{
"errors": [
{
"message": "Access to requested resource is denied.",
"code": "Unauthorized",
"details": "Access token is missing in the request header."
}
]
}
Updated 23 days ago
Bu sayfa size yardımcı oldu mu?