体质服务平台OpenAPI基本介绍

体质服务平台开放接口对接文档 version: 2.0

请登录体质服务平台官网 进入后台-应用中心-开放平台 以获取企业标识（tenant_id） ，企业API调用凭据（secret） 为了企业的数据安全，必须在管理端配置可信IP，仅配置的可信IP能调用接口。

阅读说明

• 接口请求地址为体质平台的网站域名+业务接口路径

• 体质服务平台通过开放接口（Open API）为接入企业提供进一步集成和个性化定制的能力。

• 所有接口都使用 HTTPS 协议，JSON 数据格式和 UTF-8 编码。

• 接口使用 GET 和 POST 两种操作，其他类型操作（如 PUT）皆不会用到。

• 各版本的量表编码不可混淆，在辨识接口调用时需注意各版本编码的对应关系

• GET 类型操作中可能需要 query参数。

    说明: query参数是放入url中的参数，例如 API https://www.tizhicm.com/some_api 在添加 query 参数 access_token 和 id 后完整请求为：
  
    https://www.tizhicm.com/some_api?access_token=xxx&id=xxx
  

  另外，POST 类型操作中除了 query参数 外还可能需要提供 body参数。具体会在相应业务 API 文档中介绍。

请求返回值中总是包含 errcode 和 errmsg 字段，称为基础返回字段。用于描述请求的成功状态，其定义如下：

// 正确样例
{
  "errcode": 0,
  "errmsg": "ok"
}
// 错误样例
{
  "errcode": 10001,
  "errmsg": "secret 或 tenant_id 非法"
}

错误码绝大多数情况为五位数字(例如10001），其中以「1」开头的为 全局错误码 ，以「2」开头的为 业务错误码。 业务错误码则会在各个接口对应文档中说明。

接入准备

1.进入后台-应用中心-开放平台 以获取企业标识（tenant_id） ，企业API调用凭据（secret），并设置IP白名单，如图所示。

首先 您将会在界面上看到企业的tenant_id，这是调用接口的重要凭据之一。其次secret在企业创建成功后需要手动获取，平台不会做储存且不会展示，需企业自行保管，如遗忘请点击重新获取，并且之前的secret立即失效