探马OpenAPI

对接测试

POST

/api/v3/echo

用于对接接口时测试是否对接成功，也可用于接口服务探活

请求参数

Header 参数

appId

string

应用 appId

必需

默认值:

timestamp

string

请求时间戳

必需

默认值:

sign

string

请求消息签名值

必需

默认值:

Body 参数application/json

object {0}

示例

{
  "hello": "tanmarket"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/v3/echo' \
--header 'appId;' \
--header 'timestamp;' \
--header 'sign;' \
--header 'Content-Type: application/json' \
--data-raw '{"hello": "tanmarket"}'

返回响应

🟢200成功

application/json

Body

code

integer

业务状态码

必需

成功状态为0。参见响应业务状态码表

message

string

业务状态说明。

必需

data

object

响应数据。请求参数回显

必需

headers

object

请求 Header 回显

必需

params

object

请求URL参数回显

必需

body

string

请求体回显。以 JSON 化展示

必需

示例

成功示例异常示例

{
  "code": 0,
  "message": "success",
  "data": {
    "headers": {
      "Content-Type": [
        "application/json;charset=UTF-8"
      ],
      "appId": [
        "zc_test"
      ],
      "timestamp": [
        "1595069985339"
      ],
      "sign": [
        "ca5bc736bd8debcaa70086bf2ab177c26898943ab3e4ac0f096295d2f9694ed2"
      ],
      "Content-Length": [
        "22"
      ]
    },
    "params": {
      "id": [
        "your-vip"
      ]
    },
    "body": "{\"hello\": \"tanmarket\"}"
  }
}

修改于 2022-03-04 07:45:16

接口鉴权说明

获取客户id