یک رشته ارسال شده از مشتری را بازتاب می دهد.
اگر نقطه پایانی هنگام پردازش درخواست با خطا مواجه شود، بدنه پاسخ از این نقطه پایانی باید از نوع
باشد.ErrorResponse
یک نمونه درخواست به نظر می رسد:
{
"requestHeader": {
"protocolVersion": {
"major": 2
},
"requestId": "G1MQ0YERJ0Q7LPM",
"requestTimestamp": {
"epochMillis": "1481899949606"
},
"paymentIntegratorAccountId": "InvisiCashUSA_USD"
},
"clientMessage": "Client echo message"
}
یک نمونه پاسخ موفقیت به نظر می رسد:
{
"responseHeader": {
"responseTimestamp": {
"epochMillis":"1481899950236"
}
},
"clientMessage": "Client echo message",
"serverMessage": "Debug ID 12345"
}
درخواست HTTP
POST https://www.integratorhost.example.com/v2/echo
درخواست بدن
بدنه درخواست حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{
"requestHeader": {
object ( |
زمینه های | |
---|---|
requestHeader | مورد نیاز : هدر مشترک برای همه درخواست ها. |
clientMessage | الزامی است : پیامی برای بازتاب در پاسخ. |
بدن پاسخگو
شی پاسخ برای روش اکو.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{
"responseHeader": {
object ( |
زمینه های | |
---|---|
responseHeader | مورد نیاز : هدر مشترک برای همه پاسخ ها. |
clientMessage | الزامی : پیام در درخواست دریافت شده است. |
serverMessage | اختیاری : پیام سرور، مستقل از |
RequestHeader
شی هدر که روی تمام درخواست های ارسال شده به سرور تعریف می شود.
نمایندگی JSON |
---|
{ "requestId": string, "requestTimestamp": { object ( |
زمینه های | |
---|---|
requestId | مورد نیاز : شناسه منحصر به فرد این درخواست. این رشته ای است که حداکثر طول آن 100 کاراکتر است و فقط شامل کاراکترهای "az"، "AZ"، "0-9"، ":"، "-"، و "_" است. |
requestTimestamp | الزامی : مهر زمانی این درخواست. گیرنده باید تأیید کند که این مُهر زمانی ± 60 ثانیه «اکنون» است و اگر اینطور نیست درخواست را رد کند. این مهر زمانی درخواست پس از تلاش مجدد بی تاثیر نیست. |
protocolVersion | مورد نیاز : نسخه این درخواست. |
paymentIntegratorAccountId | مورد نیاز : یک حساب منحصر به فرد با محدودیت های قراردادی را شناسایی می کند. |