标准请求和响应

请求的一般步骤如下:

  1. 根据要求构建请求头信息

    1. Access-Key:直接填充

    2. Content-Type:固定application/json

  2. 按照接口文档构建请求参数

  3. 按需调用相关接口

1. 构建HTTP请求头信息

第一种:查询类,以查看导入任务详情为例

POST /openapi/open/v1/query-task HTTP/1.1
Host: https://api.supametas.ai/
scheme: https
Content-Type: application/json
cache-control: no-cache
Access-Key: {{YOUR_API_KEY}}

第二种:待文件的处理类,以导入文本文件为例

POST /openapi/open/v1/file-task HTTP/1.1
Host: https://api.supametas.ai/
scheme: https
Content-Type: multipart/form-data
cache-control: no-cache
Access-Key: {{YOUR_API_KEY}}

2. 请求示例

请求参数加密步骤示例:

以【webhook】接口为例:

  1. 获取 Access-Key :从 Supametas.ai 平台的数据集中获取

  2. 组织请求数据

{ "url": "http://yourdomain.com/api/put"}
  1. 构建请求头,并调用接口

curl --location 'http://{{BaseUrl}}/set-webhook' \
--header 'Access-Key: 131n3cebse' \
--header 'Content-Type: application/json' \
--data '{
    "url": "https://yourdomain.com/api/put"
}'

3. 标准响应

外部结构:包含响应状态码,响应消息描述以及响应信息。

{
  "code": "",
  "message": "",
  "data": {}
}

正常响应报文:

响应报文的JSON数据体:

Parameter
Type
Description

code

STRING

正常响应码:"0"

message

STRING

正常响应的描述信息:null

data

OBJECT

响应的业务数据

最后更新于