Method: echo

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

اگر نقطه پایانی هنگام پردازش درخواست با خطا مواجه شود، بدنه پاسخ از این نقطه پایانی باید از نوع 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": 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": {
    object (Timestamp)
  },
  "protocolVersion": {
    object (Version)
  },
  "paymentIntegratorAccountId": string
}
زمینه های
requestId

string

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

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

requestTimestamp

object ( Timestamp )

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

protocolVersion

object ( Version )

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

paymentIntegratorAccountId

string

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