请输入
菜单

微信小程序H5跳转接口文档

文档版本:v1.0
更新日期:2024-10-25
接口模块:用户信息开放 API(小程序/H5 跳转场景)


一、概述

1.1 文档说明

本文档描述微信小程序/H5 跳转场景下的开放 API 接口。用户登录协会易后,可通过临时 ticket 跳转至第三方 H5 或小程序,第三方凭 ticket 获取会员基本信息。所有接口均需通过协会易分发的 appIdsecret 进行鉴权。

1.2 使用场景

场景 说明
跳转流程 用户登录协会易后,点击小程序按钮,自动跳转到指定 H5 网页地址(或小程序),并追加一个临时生成的 ticket 参数
ticket 有效期 ticket 有效期为 3 分钟,第三方获取后请尽快使用
信息获取 第三方 H5(或小程序)通过 ticket 调用接口,可返回用户基本信息;ticket 使用后立即失效,第三方需自行保存用户信息

注意:ticket 为一次性凭证,第二次调用将无法查询到数据。

1.3 基础信息

项目 说明
Base URL https://www.shanghuiyi.com/open/user
鉴权方式 所有接口需在请求中携带 appIdsecret 参数
数据格式 JSON

1.4 统一响应格式

json 复制代码
{
  "errno": 0,
  "errmsg": "成功",
  "data": {}
}
字段 类型 说明
errno int 状态码,0 表示成功,其余为异常状态
errmsg string 状态描述,若有异常则为异常提示信息
data object 业务数据

二、接口列表

序号 接口名称 请求方式 路径 说明
1 获取协会会员基本信息 GET /open/user/baseInfo 通过 ticket 获取当前登录会员的基本信息

三、接口详情

3.1 获取协会会员基本信息

3.1.1 接口说明

允许第三方通过此接口获取当前登录会员的基本信息。需提供协会易跳转时携带的临时 ticket,ticket 使用后立即失效。

3.1.2 请求信息

项目 说明
请求方式 GET
请求路径 https://www.shanghuiyi.com/open/user/baseInfo

3.1.3 请求参数

参数名 类型 必填 说明
ticket string 临时凭证,30~64 个字符,一次性使用
appId string 开放平台应用ID
secret string 开放平台密钥

注意:ticket 为一次性凭证,第二次调用将无法查询到数据。

3.1.4 请求示例

复制代码
GET https://www.shanghuiyi.com/open/user/baseInfo?ticket={ticket}&appId={your_appId}&secret={your_secret}

3.1.5 响应参数

参数名 类型 说明
errno int 状态码,0 表示成功
errmsg string 状态描述
data object 会员基本信息

data 结构

参数名 类型 说明
ownAvatar string 头像
username string 姓名
jobName string 会员身份
gender string 性别
mobile string 当前用户手机号,中间四位加敏处理
companyName string 单位名称
companyJob string 单位职务
birthday string 生日
nation string 民族
education string 学历
politicGroup string 政治面貌
socialDuty string 社会职务
email string 邮箱
idCard string 身份证号,中间几位加敏处理

3.1.6 响应示例

成功

json 复制代码
{
  "errno": 0,
  "errmsg": "成功",
  "data": {
    "ownAvatar": "https://xxxx.jpg",
    "username": "张三",
    "jobName": "会长",
    "gender": "男",
    "mobile": "188xxxx9999",
    "companyName": "xxxx有限公司",
    "companyJob": "总经理",
    "birthday": "xxx-xx-xx",
    "nation": "汉",
    "education": "本科",
    "politicGroup": "中共党员",
    "socialDuty": "xxx",
    "email": "xxx@xx.com",
    "idCard": "xxxxx"
  }
}

失败

json 复制代码
{
  "errno": -1,
  "errmsg": "请求错误"
}

四、错误码说明

errno 说明
0 成功
-1 请求错误,请求参数非法
其他 失败,具体原因见 errmsg

上一个
接口文档
下一个
活动开放接口文档
最近修改: 2026-03-11Powered by