# 服务端

# 获取SaToken

satoken是平台内的全局唯一接口调用凭据,平台调用各接口时都需使用satoken。开发者需要进行妥善保存。satoken的存储至少要保留36个字符空间。satoken的有效期目前为24个小时,需定时刷新。

基本信息

  • 接口URL: https://atmes.drgeek.cn/app/auth/gettoken?auth_key=AUTH_KEY&auth_secret=AUTH_SECRET
  • 请求方式: GET
  • Content-Type: multipart/form-data

参数说明

参数 示例值 是否必须 说明
auth_key 31565AbcdeaYN57A 第三方用户唯一凭证
auth_secret D4MEXWiAbcDeJB0JSZLdPIUEUR7ZK2Y7 第三方用户唯一凭证密钥,即auth_secret

结果说明

{
    "code": 200,
    "msg": "ok",
    "data": {
        "satoken": "de0f721c-46d0-484f-89ff-11175b444b23",
        "timeout": 86400
    }
}

# 网页授权

可以通过网页授权机制,来获取用户基本信息,进而实现业务逻辑。

访问地址:

https://atmes.drgeek.cn/mobile/auth/auth?infoId=ccf110aa20c5447db19538aca85fe268&toUrl=https%3A%2F%2Fwww.drgeek.cn

参数说明

参数 示例值 是否必须 说明
info_id ccf110aa20c5447db19538aca85fe268 应用的唯一标识
to_url https://www.drgeek.cn 授权后重定向的回调链接地址, 请使用 UrlEncode 对链接进行处理

访问结果

页面将跳转至 https://www.drgeek.cn?openid=OPENID

OPENID为用户所在主体应用下的用户ID,可以用作后续免登业务逻辑,后续发送消息通知使用。

# 消息通知

基本信息

  • 接口URL: https://atmes.drgeek.cn/app/msg/send
  • 请求方式: POST
  • Content-Type: application/json

请求参数

Header参数

参数名 示例值 参数类型 是否必填 参数描述
satoken de0f721c-46d0-484f-89ff-11175b444b23 String 通过获取SaToken接口获取

Body参数

{
    "info_id": "ccf110aa20c5447db19538aca85fe268",
    "template_type": "待入科操作通知",
    "msg": {
        "to_user_id": "oeF4_v5kCiYoBmN_a9rd0jz3wgu0",
        "to_url": "https://www.baidu.com",
        "receiveUserName": "蔡磊",
        "hospitalName": "公利医院",
        "count": "100",
        "doctorType": "规培生"
    }
}

字段描述

参数名 示例值 参数类型 是否必填 参数描述
info_id c41c06043313b8ddc44a14dcf0914a15 String 应用的唯一标识
template_type 待入科操作通知 String 消息通知类型
msg 单条发送为对象,多条发送为数组
msg.to_user_id oAqZQs1ibhXzcKB76MXltOwg1LFk String 接收人id,可通过网页授权获取
msg.to_url https://www.baidu.com String 消息点击跳转地址
msg.receiveUserName 蔡磊 String 消息通知类型中的变量参数名
msg.hospitalName 公利医院 String 消息通知类型中的变量参数名
msg.count 100 String 消息通知类型中的变量参数名
msg.doctorType 规培生 String 消息通知类型中的变量参数名
... ... ... ... ...

批量发送消息,将入参msg对象转换为数组对象即可

响应示例

{

    "code": 200,
    "msg": "ok", //返回文字描述
    "data": {
        "log_id": "5c1e1ac49a234bcfbfa098f9086d1d53" //日志id
    } //返回数据
}

# 日志查询

基本信息

  • 接口URL: https://atmes.drgeek.cn/sys/log/get
  • 请求方式: POST
  • Content-Type: multipart/form-data

请求参数

Header参数

参数名 示例值 参数类型 是否必填 参数描述
satoken de0f721c-46d0-484f-89ff-11175b444b23 String 通过获取SaToken接口获取

Query参数

参数名 示例值 参数类型 是否必填 参数描述
log_id 5c1e1ac49a234bcfbfa098f9086d1d53 String 日志id

响应示例

{

    "code": 200,
    "msg": "ok", //返回文字描述
    "data": [
        {
            "id": 33,
            "logId": "f300feb1f9374ffea22e1efb32f3c8b4", //日志id
            "logType": "sendMsg", //日志类型
            "paramInfo": "{\"count\": \"100\", \"to_url\": \"https://www.baidu.com\", \"info_id\": \"ccf110aa20c5447db19538aca85fe268\", \"doctorType\": \"规培生\", \"to_user_id\": \"oeF4_v5kCiYoBmN_a9rd0jz3wgu0\", \"template_id\": \"qbLnk48hfIvU05qm8L4SNozk2MjK1-YI57Nyr3-HGFU\", \"hospitalName\": \"公利医院\", \"receiveUserName\": \"蔡磊\"}", //入参
            "resultInfo": "{\"msgid\": 2400716004655022082, \"errmsg\": \"ok\", \"errcode\": 0}", //出参
            "deleted": "0",
            "createBy": "", //创建人
            "createTime": "2022-05-16T07:28:16.000+00:00" //创建时间
        }
    ] //返回数据
}

# 发送验证码短信

基本信息

  • 接口URL: https://atmes.drgeek.cn/app/sms/send-code
  • 请求方式: POST
  • Content-Type: application/json

请求参数

Header参数

参数名 示例值 参数类型 是否必填 参数描述
satoken de0f721c-46d0-484f-89ff-11175b444b23 String 通过获取SaToken接口获取

Body参数

{
  "mobile": "139****8696",
  "scene": "新用户注册",
  "hospitalId": "PDYY077",
  "appCode": "fe"
}
参数名 示例值 参数类型 是否必填 参数描述
mobile 139****8696 String 手机号
scene 新用户注册 String 使用场景描述
hospitalId PDYY077 String 医院ID
appCode fe String 系统CODE

响应示例

{
  "msg": "操作成功",
  "code": 200,
  "data": "000852"
}

# 校验验证码是否正确

基本信息

  • 接口URL: https://atmes.drgeek.cn/app/sms/check-code
  • 请求方式: POST
  • Content-Type: application/json

请求参数

Header参数

参数名 示例值 参数类型 是否必填 参数描述
satoken de0f721c-46d0-484f-89ff-11175b444b23 String 通过获取SaToken接口获取

Body参数

{
  "mobile": "139****8696",
  "code": "000852"
}
参数名 示例值 参数类型 是否必填 参数描述
mobile 139****8696 String 手机号
code 000852 String 验证码

响应示例

{
  "msg": "操作成功",
  "code": 200
}
上次更新时间: 10/12/2024, 2:40:06 PM