认证与用户
1. 获取账套信息
GET/api/Open/GetAccount
返回JSON数据
|
字段 |
类型 |
描述 |
可为空 |
|---|---|---|---|
|
Code |
Int |
0 成功 |
N |
|
Message |
String |
Code 不为0时给出具体错误 |
Y |
|
Accounts |
String |
账套集合 JSON 数组字符串,如 ["默认账套","ERP系统"] |
Y |
- 返回服务端允许开放的账套(受 StaticValue.Accounts 白名单过滤,未配置则返回全部账套)。
返回JSON示例
{ "Code": 0, "Message": "", "Accounts": "[\"默认账套\",\"ERP系统\"]" }2. 获取匿名访问令牌
POST/api/Open/GetAnonymousToken
请求参数
|
字段 |
类型 |
描述 |
可为空 |
|---|---|---|---|
|
Account |
String |
接入账套 |
N |
返回JSON数据
|
字段 |
类型 |
描述 |
可为空 |
|---|---|---|---|
|
Code |
Int |
0 成功 |
N |
|
Message |
String |
Code 不为0时给出具体错误 |
Y |
|
AccessToken |
String |
匿名访问令牌,格式 NX_ANONYMOUS_{AccountID} |
Y |
- 首次调用会创建匿名用户档案(登录名 everyone / 匿名用户);得到的 AccessToken 请全局缓存,后续接口通用。服务器检测到令牌无效或过期时拒绝访问。
3. 校验访问令牌
POST/api/Open/CheckAccessToken
请求参数
|
字段 |
类型 |
描述 |
可为空 |
|---|---|---|---|
|
AccessToken |
String |
访问令牌 |
N |
返回JSON数据
|
字段 |
类型 |
描述 |
可为空 |
|---|---|---|---|
|
Code |
Int |
0 成功;1 令牌为空/已失效 |
N |
|
Message |
String |
具体错误 |
Y |
|
Token |
String |
访问令牌 |
Y |
|
UserID |
String |
用户ID |
Y |
|
UserName |
String |
用户名称 |
Y |
|
LoginName |
String |
登录名 |
Y |
|
DeptName |
String |
所属部门名称 |
Y |
|
DeptNo |
String |
所属部门编号 |
Y |
|
BrachName |
String |
所属机构名称 |
Y |
|
PhotoUrl |
String |
头像URL(相对路径,无则空) |
Y |
|
LoginTemplateID |
String |
初始化模板ID |
Y |
|
InitSummary |
Boolean |
初始化是否链接汇总 |
Y |
4. 获取用户访问令牌
POST/api/Open/GetAccessToken
请求参数
|
字段 |
类型 |
描述 |
可为空 |
|---|---|---|---|
|
Account |
String |
接入账套 |
N |
|
LoginName |
String |
接入用户登录名 |
N |
|
Password |
String |
接入用户密码(加密串,空格还原为 +) |
Y |
|
ProfileType |
Int |
授权类型(如 1 消耗移动端授权) |
Y |
返回JSON数据
|
字段 |
类型 |
描述 |
可为空 |
|---|---|---|---|
|
Code |
Int |
0 成功 |
N |
|
Message |
String |
Code 不为0时给出具体错误 |
Y |
|
AccessToken |
String |
访问令牌,API访问的凭证 |
Y |
- ClientType 固定为 9(OpenAPI 渠道);得到的 AccessToken 请全局缓存。
5. 获取登录用户信息
POST/api/Open/GetUserProfile
请求参数
|
字段 |
类型 |
描述 |
可为空 |
|---|---|---|---|
|
AccessToken |
String |
访问令牌 |
N |
返回JSON数据
|
字段 |
类型 |
描述 |
可为空 |
|---|---|---|---|
|
Code |
Int |
0 成功 |
N |
|
Message |
String |
具体错误 |
Y |
|
UserID |
String |
用户ID |
Y |
|
UserName |
String |
用户名称(显示名) |
Y |
|
DeptID |
String |
所属部门ID |
Y |
|
DeptName |
String |
所属部门名称 |
Y |
|
PostID |
String |
岗位/角色串(可做权限判断) |
Y |
|
PostName |
String |
岗位角色名 |
Y |
|
AccountName |
String |
接入账套 |
Y |
|
PhotoUrl |
String |
头像URL(相对路径) |
Y |
17. 通过第三方授权获取访问令牌
POST/api/Open/GetAccessTokenFromOAuth
请求参数
|
字段 |
类型 |
描述 |
可为空 |
|---|---|---|---|
|
Account |
String |
接入账套 |
N |
|
OAuthType |
String |
第三方类型 |
N |
|
OAuthToken |
String |
对应的OpenID |
N |
返回JSON数据
|
字段 |
类型 |
描述 |
可为空 |
|---|---|---|---|
|
Code |
Int |
0 成功;1 免登录失败;3 用户不存在 |
N |
|
Message |
String |
具体错误 |
Y |
|
AccessToken |
String |
访问令牌,API访问的凭证 |
Y |
- 按 OpenID 在账套中匹配用户后颁发令牌(ClientType=9 OpenAPI 渠道)。