Эхо возвращает строку, отправленную от клиента.
Если конечная точка обнаруживает ошибку при обработке запроса, тело ответа от этой конечной точки должно иметь тип
.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 | ОБЯЗАТЕЛЬНО : сообщение для отражения в ответе. |
Тело ответа
Объект ответа для метода echo.
В случае успеха тело ответа содержит данные следующей структуры:
JSON-представление |
---|
{
"responseHeader": {
object ( |
Поля | |
---|---|
responseHeader | ОБЯЗАТЕЛЬНО : общий заголовок для всех ответов. |
clientMessage | ОБЯЗАТЕЛЬНО : сообщение, полученное в запросе. |
serverMessage | НЕОБЯЗАТЕЛЬНО : сообщение сервера, независимо от отображаемого |
Заголовок запроса
Объект заголовка, который определяется для всех запросов, отправляемых на сервер.
JSON-представление |
---|
{ "requestId": string, "requestTimestamp": { object ( |
Поля | |
---|---|
requestId | ОБЯЗАТЕЛЬНО : уникальный идентификатор этого запроса. Это строка максимальной длиной 100 символов, содержащая только символы «az», «AZ», «0-9», «:», «-» и «_». |
requestTimestamp | ОБЯЗАТЕЛЬНО : временная метка этого запроса. Получатель должен убедиться, что эта временная метка составляет ± 60 с от «сейчас», и отклонить запрос, если это не так. Эта временная метка запроса не является идемпотентной при повторных попытках. |
protocolVersion | ОБЯЗАТЕЛЬНО : версия этого запроса. |
paymentIntegratorAccountId | ОБЯЗАТЕЛЬНО : идентифицирует уникальную учетную запись с договорными ограничениями. |