Platform API平台接口

Health健康检查

Liveness, maintenance status and our clock. No signature.存活、维护状态与平台时钟，不需要签名。

GET/merchant/v1/health

Called by the merchant商户调用 · no signature无需签名

Liveness and maintenance status. No headers required.

存活与维护状态，不需要请求头。

During maintenance: {"code":"MAINTENANCE","message":"System maintenance"} with HTTP 200. Unreachable means unavailable; retry with backoff. Use serverTime to check your clock.

维护中返回 {"code":"MAINTENANCE","message":"System maintenance"}（HTTP 200）。连不上视为不可用，退避重试。serverTime 可用来核对本机时钟。

Result codes结果码

OK MAINTENANCE

In addition to the common codes listed in另可能返回通用结果码，见 Result codes结果码.

Test cases测试用例

Run each case against the staging environment before go-live. Signature, timestamp, request ID and IP cases apply to every endpoint and are listed under上线前请在测试环境逐条执行。签名、时间戳、请求编号与 IP 相关用例适用于所有接口，见 Authentication签名认证.

H-01 Normal正常 Normal正常 Expected期望 OK

GET /merchant/v1/health without signing headers不带签名请求头的 GET /merchant/v1/health

data.serverTime is within a few seconds of your clock.data.serverTime 与本机时钟相差不超过几秒。

H-02 Configuration配置 During maintenance维护期间 Expected期望 MAINTENANCE (HTTP 200)

merchant.maintenance = true, publishedmerchant.maintenance 设为 true 并发布

HTTP 200. Stop launching players; poll with backoff.HTTP 200。暂停让玩家进游戏，退避轮询。

H-03 Normal正常 Not cached不可缓存 Expected期望 OK, Cache-Control: no-store

Response headers of GET /healthGET /health 的响应头

resp, err := http.Get("https://" + apiHost + "/merchant/v1/health") if err != nil { return err } defer resp.Body.Close() var env struct{ Code, Message string; Data json.RawMessage } err = json.NewDecoder(resp.Body).Decode(&env)

HttpResponse<String> resp = HttpClient.newHttpClient().send( HttpRequest.newBuilder(URI.create("https://" + API_HOST + "/merchant/v1/health")).GET().build(), HttpResponse.BodyHandlers.ofString()); System.out.println(resp.body());