Method: echo

clientMessage ارسال شده را بازتاب می دهد.

هدف از این روش آزمایش اتصال اولیه بین یکپارچه‌ساز پرداخت و گوگل است.

اگر نقطه پایانی هنگام پردازش درخواست با خطا مواجه شود، پاسخ این نقطه پایانی از نوع ErrorResponse خواهد بود.

اگر این روش یک HTTP 200 را برنگرداند، ممکن است پاسخ‌های این عبارت خالی باشد. بدنه پاسخ در شرایطی که می‌توان از یک ErrorResponse با توضیح واضح برای کمک به مهاجم برای درک شناسه حساب یکپارچه‌ساز پرداخت سایر ادغام‌کننده‌ها استفاده کرد، خالی است. در این شرایط، که یا کلید امضا مطابقت ندارد، شناسه یکپارچه پرداخت پیدا نشد، یا کلید رمزگذاری ناشناخته بود، این روش یک HTTP 404 را با بدنه خالی برمی گرداند. اگر امضای درخواست تأیید شود، اطلاعات اضافی در مورد خطا در بدنه پاسخ بازگردانده می شود.

یک نمونه درخواست به نظر می رسد:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 1,
      "minor": 0,
      "revision": 0
    },
    "requestId": "ZWNobyB0cmFuc2FjdGlvbg",
    "requestTimestamp": "1481899949606"
  },
  "clientMessage": "client message"
}

یک نمونه پاسخ به نظر می رسد:


{
  "responseHeader": {
    "responseTimestamp": "1481900013178"
  },
  "clientMessage": "client message",
  "serverMessage": "server message"
}

درخواست HTTP

POST https://vgw.googleapis.com/secure-serving/gsp/v1/echo/ :PIAID

درخواست بدن

بدنه درخواست حاوی داده هایی با ساختار زیر است:

نمایندگی JSON
{
  "requestHeader": {
    object (RequestHeader)
  },
  "clientMessage": string
}
زمینه های
requestHeader

object ( RequestHeader )

مورد نیاز : هدر مشترک برای همه درخواست ها.

clientMessage

string

الزامی است : پیامی برای بازتاب در پاسخ.

بدن پاسخگو

شی پاسخ برای روش اکو.

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "clientMessage": string,
  "serverMessage": string
}
زمینه های
responseHeader

object ( ResponseHeader )

مورد نیاز : هدر مشترک برای همه پاسخ ها.

clientMessage

string

الزامی : پیام در درخواست دریافت شده است.

serverMessage

string

اختیاری : پیام سرور، مستقل از clientMessage که بازتاب داده می شود.

RequestHeader

شی هدر که روی تمام درخواست های ارسال شده به سرور تعریف می شود.

نمایندگی JSON
{
  "requestId": string,
  "requestTimestamp": string,
  "userLocale": string,
  "protocolVersion": {
    object (Version)
  }
}
زمینه های
requestId

string

مورد نیاز : شناسه منحصر به فرد این درخواست.

این رشته ای است که حداکثر طول آن 100 کاراکتر است و فقط شامل کاراکترهای "az"، "AZ"، "0-9"، ":"، "-"، و "_" است.

requestTimestamp

string ( int64 format)

الزامی است : مهر زمانی این درخواست به عنوان میلی ثانیه از آن دوره نشان داده شده است. گیرنده باید تأیید کند که این مُهر زمانی ± 60 ثانیه «اکنون» است. این مهر زمانی درخواست پس از تلاش مجدد بی تاثیر نیست.

userLocale
(deprecated)

string

منسوخ شده : کد زبان ISO 639-2 آلفا 3 دو یا سه حرفی که به صورت اختیاری با خط فاصله و کد کشور ISO 3166-1 آلفا-2، به عنوان مثال، «pt-BR»، «fil» یا 'fil-PH'. از این برای کمک به هدایت فیلدهای userMessage در پاسخ استفاده کنید.

protocolVersion

object ( Version )

مورد نیاز : نسخه این درخواست.

نسخه

شئ نسخه که شکلی ساختار یافته از ساختار نسخه کلاسیک abc است. نسخه‌های اصلی همین تعداد تضمین می‌شوند که سازگار باشند. توجه داشته باشید که اصلاحات جزئی و جزئی می توانند اغلب و بدون اطلاع قبلی تغییر کنند. یکپارچه کننده باید از همه درخواست ها برای یک نسخه اصلی پشتیبانی کند.

نمایندگی JSON
{
  "major": integer,
  "minor": integer,
  "revision": integer
}
زمینه های
major

integer

مورد نیاز : نسخه اصلی. این برای درخواست‌های سازگاری با نسخه‌های مختلف علامت‌گذاری شده است و تضمین نمی‌شود که سازگار باشند.

minor

integer

مورد نیاز : نسخه کوچک. این نشان دهنده رفع اشکال قابل توجه است.

revision

integer

مورد نیاز : نسخه کوچک. این نشان دهنده رفع اشکال جزئی است.