接口描述

第三方用户可通过调用开放平台提供的API获取到脉景健康的中药、方剂、症状、疾病等数据以及智能辅助诊断结果,因为涉及数据隐私,所以在使用前必须获得脉景健康的授权,才可以调用API(公开数据除外)。

授权方式

开放平台采用OAuth 2.0作为授权协议,授权流程可以简单归纳为:

  1. 获取临时令牌。

  2. 用临时令牌换取长时令牌以及访问令牌。

  3. 访问令牌过期后用长时令牌刷新访问令牌。


概念介绍
  1. client_idclient_secret
    client_id是脉景健康提供给第三方用户的唯一凭证,client_secret是脉景健康提供给第三方用户的唯一凭证密钥,它们相当于用户名和密码,请妥善保存。

  2. grant_type 此次登陆所使用的方式。目前只支持client_credentials

  3. scope 用户登陆的作用域范围。目前都使用open-user

  4. access_token
    即用户授权令牌,为用户一次会话的授权标识。第三方用户在调用脉景健康的接口时,需要带上access_token,也只有access_token才能作为访问的凭证。

  5. expires_in
    凭证有效时间,默认10小时,单位:秒。目前access_token的有效期通过返回的expire_in来传达,第三方用户需要根据这个有效时间提前去刷新access_token


接口调用请求说明
  • 请求地址: https://user.macrocura.com/user/oauth2/token/

  • 请求方法: POST

API版本要求
请求示例
  • POST https://user.macrocura.com/user/oauth2/token/
使用form-data格式

{
    "client_id": "CLIENT_ID",
    "client_secret": "CLIENT_SECRET",
    "grant_type": "client_credentials",
    "scope": "open-user"
}
请求参数
名称 类型 是否必填 最大长度 描述
client_id String 128 脉景健康分配给第三方用户唯一凭证
client_secret String 128 脉景健康分配给第三方用户唯一凭证密钥
grant_type String 128 此次登陆所使用的方式(client_credentials)
scope String 128 请求登陆的作用范围(open-user)
响应示例
{
    "access_token":"ACCESS_TOKEN",
    "expires_in":7200
}
返回数据说明
名称 类型 描述
access_token String 获取到的凭证
expires_in Number 凭证有效时间

TOKEN使用

在HTTP请求的HEAD中添加 Authorization: Bearer ACCESS_TOKEN

By Macrocura, Copyright © 2020 all right reserved,powered by Gitbook            Last update: 2021-01-20 10:19:15