Method: echo

回显传入的 clientMessage

此方法旨在测试付款集成商与 Google 之间的基本连接。

Google 每分钟可能会使用有效或无效参数多次调用此方法,以测试安全约束是否得到正确执行。Google 还会根据集成商和 Google 的指示,将此方法称为临时方法。Google 的调用频率绝不会超过每 10 秒一次,并且在 15 分钟内调用的次数绝不会超过 30 次。

安全约束测试的示例(但不限于):

  • 进行测试,以确保付款集成商的端点不会与安全系数低的加密套件协商。
  • 进行测试以确保付款集成商的端点不会与 TLS 1.2 以外的任何内容进行协商
  • 进行测试以确保付款集成商的端点不支持 HTTP。
  • 进行测试,以确保付款集成商的端点强制要求使用至少一个已知的 PGP 签名密钥。
  • 进行测试以确保付款集成商的端点支持多个 PGP 密钥签名(包括已知和未知的已到期和活跃的 PGP 密钥签名)。
  • 进行测试,以确保付款集成商仅支持严格的 JSON 解析。

如果端点在处理请求时遇到错误,来自此端点的响应正文的类型应为 ErrorResponse

示例请求如下所示:


{
  "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://www.integratorhost.example.com/v1/echo

请求正文

请求正文中包含结构如下的数据:

JSON 表示法
{
  "requestHeader": {
    object (RequestHeader)
  },
  "clientMessage": string
}
字段
requestHeader

object (RequestHeader)

必需:所有请求的通用标头。

clientMessage

string

REQUIRED:要在响应中回显的消息。

响应正文

echo 方法的响应对象。

如果成功,响应正文将包含结构如下的数据:

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 个字符的字符串,并且仅包含字符“a-z”“A-Z”“0-9”“:”“-”和“_”。

requestTimestamp

string (int64 format)

必需:此请求的时间戳,以自纪元以来的毫秒数表示。接收者应验证此时间戳是否为“现在”的 ± 60 秒。此请求时间戳在重试时不具有幂等性。

userLocale
(deprecated)

string

已弃用:由两个或三个字母组成的 ISO 639-2 Alpha 3 语言代码(可视需要后跟连字符和 ISO 3166-1 Alpha-2 国家/地区代码),例如“pt”“pt-BR”“fil”或“fil-PH”。使用此方法有助于驱动响应中的 userMessage 字段。

protocolVersion

object (Version)

必需:此请求的版本。

版本

Version 对象,是经典 a.b.c 版本结构的结构化形式。相同编号的主要版本保证兼容。请注意,次要和修订可能会频繁变动,恕不另行通知。集成商必须支持针对同一主要版本的所有请求。

JSON 表示法
{
  "major": integer,
  "minor": integer,
  "revision": integer
}
字段
major

integer

必需:主要版本。此属性会被标记为不同版本的兼容性请求,但这并不保证兼容。

minor

integer

必需:次要版本。这表示修复了重大问题。

revision

integer

必需:次要版本。表示小的 bug 修复。