API定义

返回
此文档将定义InteractivePDK2021开发过程中前端和后端的交互流程

目录

• API定义
  • 目录
  • 0.0 公共常数及API约定
    • 0.1 发送方式(SEND_METHOD)
    • 0.2 错误代码(errorCode)
    • 0.3 通用返回格式
    • 0.4 API参数发送方式
    • 0.5 UserEntity定义
    • 0.6 LoginFailedReason登陆失败原因定义
    • 0.7 服务端格式同步
    • 0.8 验证码系统
    • 0.9 APP类型定义
    • 0.10 APPEntity定义
    • 0.11 MaskID定义
    • 0.12 UserSettingEntity定义
    • 0.13 OAuthScope定义
    • 0.14 OAuthToken定义
    • 0.15 OAuthUserInfo定义
    • 0.16 TicketResponse定义
    • 0.17 TicketEntity定义
    • 0.18 MultipleResult定义
    • 0.19 UserPermissionEntity定义(提案阶段)
    • 0.20 APPPermissionEntity数据类型定义
  • 1.0 用户系统
    • 1.1 注册用户
      • 1.1.1 请求方式
      • 1.1.2 参数
      • 1.1.3 返回值
    • 1.2 验证邮箱
      • 1.2.1 请求方式
      • 1.2.2 参数
      • 1.2.3 返回值
    • 1.3 验证手机
      • 1.3.1 请求方式
      • 1.3.2 参数
      • 1.3.3 返回值
    • 1.4 请求邮箱验证重发
      • 1.4.1 请求方式
      • 1.4.2 参数
      • 1.4.3 返回值
    • 1.5 请求手机验证重发
      • 1.5.1 请求方式
      • 1.5.2 参数
      • 1.5.3 返回值
    • 1.6 登录
      • 1.6.1 请求方式
      • 1.6.2 参数
      • 1.6.3 返回值
        • 1.6.3.1 失败时定义
        • 1.6.3.2 成功时定义
    • 1.7 验证token
      • 1.7.1 请求方式
      • 1.7.2 参数
      • 1.7.3 返回值
    • 1.8 刷新登录凭据
      • 1.8.1 请求方式
      • 1.8.2 参数
      • 1.8.3 返回值
    • 1.9 登出
      • 1.9.1 请求方式
      • 1.9.2 参数
      • 1.9.3 返回值
    • 1.10 请求一个新的更改密保邮箱的验证码
      • 1.10.1 请求方式
      • 1.10.2 参数
      • 1.10.3 返回值
    • 1.11 请求一个新的更改密保手机的验证码
      • 1.11.1 请求方式
      • 1.11.2 参数
      • 1.11.3 返回值
    • 1.12 更改/添加密保邮箱
      • 1.12.1 请求方式
      • 1.12.2 参数
        • 1.12.2.1 添加密保邮箱时参数
        • 1.12.2.2 更改密保邮箱时参数
      • 1.12.3 返回值
    • 1.13 更改/添加密保手机
      • 1.13.1 请求方式
      • 1.13.2 参数
        • 1.13.2.1 添加密保手机时参数
        • 1.13.2.2 更改密保手机时参数
      • 1.13.3 返回值
    • 1.14 请求一个更改密码/忘记密码的验证码
      • 1.14.1 请求方式
      • 1.14.2 参数
        • 1.14.2.1 更改密码参数
        • 1.14.2.2 重设密码参数
      • 1.14.3 返回值
    • 1.15 更改密码/重设密码
      • 1.15.1 请求方式
      • 1.15.2 参数
        • 1.15.2.1 更改密码参数
        • 1.15.2.2 重设密码参数
      • 1.15.3 返回值
    • 1.16 更改用户信息
      • 1.16.1 请求方式
      • 1.16.2 参数
        • 1.16.2.1 更改密码参数
      • 1.16.3 返回值
    • 1.17 列出已有面具
      • 1.17.1 请求方式
      • 1.17.2 参数
      • 1.17.3 返回值
    • 1.18 添加面具
      • 1.18.1 请求方式
      • 1.18.2 参数
      • 1.18.3 返回值
    • 1.19 修改面具信息
      • 1.19.1 请求方式
      • 1.19.2 参数
      • 1.19.3 返回值
    • 1.20 删除面具
      • 1.20.1 请求方式
      • 1.20.2 参数
      • 1.20.3 返回值
  • 2.0 第三方OAuth APP系统
    • 2.1 注册APP
      • 2.1.1 请求方式
      • 2.1.2 参数
      • 2.1.3 返回值
    • 2.2 列出已有APP
      • 2.2.1 请求方式
      • 2.2.2 参数
      • 2.2.3 返回值
    • 2.3 请求删除APP验证码
      • 2.3.1 请求方式
      • 2.3.2 参数
      • 2.3.3 返回值
    • 2.4 删除已有APP
      • 2.4.1 请求方式
      • 2.4.2 参数
      • 2.4.3 返回值
    • 2.5 请求APP重要操作验证码
      • 2.5.1 请求方式
      • 2.5.2 参数
      • 2.5.3 返回值
    • 2.6 修改APP信息
      • 2.6.1 请求方式
      • 2.6.2 参数
      • 2.6.3 返回值
  • 3.0 OAuth前端用API
    • 3.1 获取Auth_Code
      • 3.1.1 请求方式
      • 3.1.2 参数
      • 3.1.3 返回值
  • 4.0 OAuth APP用API
    • 4.1 获取访问令牌APPToken / access_token
      • 4.1.1 请求方式
      • 4.1.2 参数
      • 4.1.3 返回值
    • 4.2 验证访问令牌
      • 4.2.1 请求方式
      • 4.2.2 参数
      • 4.2.3 返回值
    • 4.3 刷新访问令牌
      • 4.3.1 请求方式
      • 4.3.2 参数
      • 4.3.3 返回值
    • 4.4 获取用户基础信息
      • 4.4.1 请求方式
      • 4.4.2 参数
      • 4.4.3 返回值
    • 4.5 发送提醒/营销信息
      • 4.5.1 请求方式
      • 4.5.2 参数
      • 4.5.3 返回值
  • 5.0 工单系统API
    • 5.1 新建工单
      • 5.1.1 请求方式
      • 5.1.2 参数
      • 5.1.3 返回值
    • 5.2 用户列出工单
      • 5.2.1 请求方式
      • 5.2.2 参数
      • 5.2.3 返回值
    • 5.3 回复工单
      • 5.3.1 请求方式
      • 5.3.2 参数
        • 5.3.2.1 用户请求时参数
        • 5.3.2.2 APP请求时参数
      • 5.3.3 返回值
    • 5.4 查询工单信息
      • 5.4.1 请求方式
      • 5.4.2 参数
        • 5.4.2.1 用户请求时参数
        • 5.4.2.2 APP请求时参数
      • 5.4.3 返回值
    • 5.5 APP查询拥有的工单数量
      • 5.5.1 请求方式
      • 5.5.2 参数
      • 5.5.3 返回值
    • 5.6 APP列出已有工单
      • 5.6.1 请求方式
      • 5.6.2 参数
      • 5.6.3 返回值
    • 5.7 更改已有工单状态
      • 5.7.1 请求方式
      • 5.7.2 参数
        • 5.7.2.1 用户请求时参数
        • 5.7.2.2 APP请求时参数
      • 5.7.3 返回值

0.0 公共常数及API约定

0.1 发送方式(SEND_METHOD)

见PDK2021-CoreLib中SentMethod.php中的定义.

0.2 错误代码(errorCode)

见PDK2021-CoreLib中PDKErrCode.php中的定义.

0.3 通用返回格式

先上JSON格式的数据, 所有请求的返回值都会是一个JSON字符串(除了成功的HTTP DELETE)

{
    "errorCode": 0,
    "errorDescription": "这里真的没有错误!",
    "errorFile": "错误文件在哪里?",
    "errorLine": 0,
    "data": {
        "data1": "xxx",
        "data2": "xxxx",
        ...
    },
    "additional-error-params-1": "xxx",
    "additional-error-params-2": "xxx",
    ...,
    "user-defined-root-data-1": "value1",
    "user-defined-root-data-2": "value2",
    ...
}

在这里additional-error-params指的是0.2 错误代码中定义的错误参数名称.

在看完示例后我们再看看具体这个JSON格式的数据的键值在什么时候会出现

0.4 API参数发送方式

在执行API请求时, 不同的HTTP Method有不同的参数接收方式

注: 如果API定义的URL中有则用变量值替代, 且请求体中无需再次包含变量.

0.5 UserEntity定义

UserEntity经常在API中作为一个数据类型被返回, 实际UserEntity也是一个JSON Object, 具体格式如下:

{
    "uid": 0,
    "username": "User Username",
    "nickname": "User Nickname",
    "signature": "User Signature",
    "email": "Email Address",
    "phone": "Phone Number in E164 Format",
    "emailVerified": true,
    "phoneVerified": true,
    "accountFrozen": false,
    "settings": {
      "allowEmailNotifications": 2,
      "allowSaleEmail": 2,
      "allowSMSNotifications": 2,
      "allowSaleEmail": 2,
      "allowCallNotifications": 2,
      "allowSaleCall": 2
    }
}

看完例子来看一下UserEntity的数据定义吧

还是不懂?
如果一个API返回了UserEntity, 如登录功能, 则API返回值会如下所示(以登录功能为例)

{
    "errorCode": 0,
    "data": {
        "access_token": "xxxx",
        "refresh_token": "xxx",
        "access_expire": 11283901,
        "refresh_expire": 12319890,
        "user": {
            "uid": 1,
            "username": "toiletcommander",
            "nickname": "老秋风",
            "signature": "哇我爱糖糖, 糖糖怎么那么好看, 声音又好听",
            "email": "[email protected]",
            "phone": "+86xxxxxxxxxxx",
            "emailVerified": true,
            "phoneVerified": true,
            "accountFrozen": false,
            "settings": {
              "allowEmailNotifications": 2,
              "allowSaleEmail": 2,
              "allowSMSNotifications": 2,
              "allowSaleEmail": 2,
              "allowCallNotifications": 2,
              "allowSaleCall": 2
            }
        }
    }
}

0.6 LoginFailedReason登陆失败原因定义

见PDK-2021CoreLib中LoginFailedReasons.php

0.7 服务端格式同步

因为PDK2021的可配置性, 许多变量的格式在不同的部署实例中是不同的, 要了解具体什么需要配置, 请参照下面的链接.

强烈建议在实现前端时将UserSystemFormatSetting写成一个可以更改的类文件

• VeriCodeFormat / 验证码格式定义, 定长32个字符(base16)
  • 注: 手机验证码定长6个字符, 虽然字符数少了但是请求时需要带上uid
• TokenFormat / 登录凭据和刷新凭据定义, 定长32个字符(base16)
• PasswordHash / 密码哈希, 定长64个字符(base16, SHA256)
• UserSystemFormatSetting / 用户系统可变定义
• UserSystemFormatSetting / 用户系统可变定义服务端实现,见USER_SYSTEM_CONSTRAINTS
• APPFormat / APP系统定义, client_id, client_secret定长40个字符, access_token, refresh_token, auth_code定长32个字符, code_challenge(s256)定长64字符
• MaskIDFormat / MaskID定义, mask_id定长32个字符, display_name定长<=20个字符
• APPSystemFormatSetting / APP系统可变定义
• APPSystemFormatSetting / APP系统可变定义服务端实现,见APP_SYSTEM_FORMAT_CONSTRAINTS
• OAuthTicketFormatSetting / 工单系统可变定义
• OAuthTicketFormatSetting / 工单系统可变定义服务端实现, 见OAUTH_TICKET_SYSTEM_FORMAT_CONSTRAINTS

0.8 验证码系统

验证码系统后端设计时已尽量减少耦合, 下面是验证码系统的交互逻辑

1. 前端从验证码API申请一个验证码,获取captcha_id, captcha_data和expire_time, 其中captcha_id是一个定长为32个字符的随机字符串, captcha_data是和验证码系统后端实现有关的提供给前端的验证码数据(图片, 或极验id等等), expire_time是验证码过期时间, 代表用户需要提交表单的时间(UTC)
2. 前端在用户填写完验证码后调用验证码验证API, 此API用来检查用户输入的验证码是否正确, 如果正确, 则API会将验证码标记为已验证
3. 前端在用户填写完表单后调用特定表单API, 附上验证码的captcha_id, 后端验证验证码是否已经过期以及验证码是否已被标记为已验证

不同的验证码系统拥有不同的API, 如果您想使用内置的SimpleCaptcha, 您可以参阅文档

0.9 APP类型定义

见PDK-2021CoreLib中PDKAPPType.php

0.10 APPEntity定义

APPEntity经常在API中作为一个数据类型被返回, 实际APPEntity也是一个JSON Object, 具体格式如下:

{
    "appuid": 0,
    "display_name": "APP Display Name",
    "client_id": "APP Client ID",
    "client_secret": "APP Client Secret",
    "client_type": 1,
    "redirectURI": "https://localhost/",
    "create_time": 0,
    "owner_uid": 0
}

看完例子来看一下APPEntity的数据定义吧

还是不懂?
如果一个API返回了APPEntity, 如创建APP, 则API返回值会如下所示(以登录功能为例)

{
    "errorCode": 0,
    "data": {
        "app": {
            "appuid": 0,
            "display_name": "Readin",
            "client_id": "WJIISMJWIJIJDSIWJIDJIWJI(40 Chars)",
            "client_secret": "JWIMZNWBDJWHSMDBWJSMWJDGZTYWUDMDGWBS(40 Chars)",
            "client_type": 1,
            "redirectURI": "https://localhost/",
            "create_time": 1159000,
            "owner_uid": 2
        }
    }
}

0.11 MaskID定义

MaskID是用户在OAuth授权第三方APP时创建的面具, 可以视为一个用户拥有的多个第三方APP账户. 在API返回MaskID实例数据时将以JSON格式返回, 具体格式如下:

{
    "mask_id": "xxxx",
    "client_id": "xxxxxxxxxxxx",
    "uid": 32,
    "display_name": "形影",
    "createTime": 128930189023,
    "settings": {
      "allowEmailNotifications": 2,
      "allowSaleEmail": 2,
      "allowSMSNotifications": 2,
      "allowSaleEmail": 2,
      "allowCallNotifications": 2,
      "allowSaleCall": 2
    }
}

看完例子来看一下MaskID的数据定义吧

0.12 UserSettingEntity定义

UserSettingEntity是用户设置数据的抽象化实例. API通常在返回UserEntity和MaskIDEntity时返回UserSettingEntity, 在API返回UserSettingEntity实例数据时将以JSON格式返回, 具体格式如下:

SettingBoolean.php 我们首先定义, 在本JSON中所有键值皆为int, 且范围限定SettingBoolean如下:

{
    "allowEmailNotifications": 2,
    "allowSaleEmail": 2,
    "allowSMSNotifications": 2,
    "allowSaleEmail": 2,
    "allowCallNotifications": 2,
    "allowSaleCall": 2
}

看完例子来看一下UserSettingEntity的数据定义吧

0.13 OAuthScope定义

OAuthScope是第三方APP在申请用户授权时指定的授权范围(也是用户选择授权时可以指定的授权范围). 具体格式如下:

OAuthScope.php

0.14 OAuthToken定义

OAuthScope是第三方APP在申请访问令牌时获取到的访问令牌, 具体格式如下:

0.15 OAuthUserInfo定义

OAuthUserInfo是在第三方请求用户信息时提供, 是一个MaskIDEntity的缩减版:

0.16 TicketResponse定义

TicketResponse是作为工单拓展系统中使用的一个工单上的一条回复:

0.17 TicketEntity定义

TicketEntity是作为工单拓展系统中的工单结构体:

0.18 MultipleResult定义

MultipleResult<T>作为一个搜索结果被返回, 是一个模板数据格式:

0.19 UserPermissionEntity定义(提案阶段)

UserPermissionEntity是用户权限数据的抽象化实例. UserPermission, 在API返回UserSettingEntity实例数据时将以JSON格式返回, 具体格式如下:

UserPermission取值为SettingBoolean,在True/False基础上增加了INHERIT(继承),见UserSettingEntity中对SettingBoolean的定义

{
  "isSuperAdmin": SettingBoolean::SET_YES,
  "isNormalAdmin": SettingBoolean::SET_YES,
  "UserModPerm": {
    "AllGrant": SettingBoolean::SET_YES,
    "AddUser": SettingBoolean::SET_YES,
    "DelUser": SettingBoolean::SET_YES,
    "GetUserInfo": SettingBoolean::SET_YES,
    "ModifyUser":SettingBoolean::SET_YES
  },
  ...
}

isSuperAdmin代表该用户是否是超级管理员，若为超级管理员，授予该用户所有板块的权限，忽略下列所有板块参数 isNormalAdmin代表该用户是否是管理员，若为管理员，授予该用户特定板块权限的权限，若须指定该用户权限，只需填写指定权限json即可 AllGrant为所有权限列表中的固定变量，若该参数为true，则忽略下列参数，授予该用户在该板块中所有权限

普通管理员所拥有的权限如下 |键值|类型|默认值|注释| |-|-|-|-| |UserModPerm|UserModPermEntity|-|赋予所有用户管理板块的权限| |TicketModPerm|TicketModPermEntity|-|赋予所有工单板块权限| |APPModPerm|APPModPermEntity|-|赋予所有APP板块权限|

UserModPermEntity权限列表有如下参数

TicketModPermEntity权限列表有如下参数

APPModPermEntity权限列表有如下参数

0.20 APPPermissionEntity数据类型定义

TicketEntity是作为APP系统中返回的APP权限结构体:

1.0 用户系统

1.1 注册用户

这个API用来让没有形随意动账号的用户注册

1.1.1 请求方式

1.1.2 参数

注意: email和phone必填一项

1.1.3 返回值

成功时dataKey-data定义:

成功时rootKey-data定义: 无特殊键值

1.2 验证邮箱

这个API用来让新注册用户/刚刚修改密保邮箱的用户验证新邮箱地址

1.2.1 请求方式

1.2.2 参数

1.2.3 返回值

成功时dataKey-data定义:

成功时rootKey-data定义: 无特殊键值

1.3 验证手机

这个API用来让新注册用户/刚刚修改密保手机的用户验证手机号码

1.3.1 请求方式

1.3.2 参数

1.3.3 返回值

成功时dataKey-data定义:

成功时rootKey-data定义: 无特殊键值

1.4 请求邮箱验证重发

这个API用来让新注册用户/刚刚修改密保邮箱的用户重新发送验证邮箱的邮件

1.4.1 请求方式

1.4.2 参数

1.4.3 返回值

成功时dataKey-data定义: 空

成功时rootKey-data定义: 无特殊键值

1.5 请求手机验证重发

这个API用来让新注册用户/刚刚修改密保手机的用户重新发送验证手机的短消息/语音电话

1.5.1 请求方式

1.5.2 参数

1.5.3 返回值

成功时dataKey-data定义:

成功时rootKey-data定义: 无特殊键值

1.6 登录

这个API用来让已验证用户登录并获取token

1.6.1 请求方式

1.6.2 参数

注: username,email,phone选一样填就行了, 有且只有一项可以填(不然会按优先级username>email>phone来选一项查找账号)

1.6.3 返回值

1.6.3.1 失败时定义

dataKey-data定义:

rootKey-data定义: 无特殊键值

特殊情况: 用户没有验证邮箱/手机返回:

dataKey-data定义:

rootKey-data定义: 继承1.2.3.1 失败时定义

1.6.3.2 成功时定义

dataKey-data定义:

rootKey-data定义: 无特殊键值

1.7 验证token

这个API用来让已经登录的用户验证token是否可用

1.7.1 请求方式

1.7.2 参数

1.7.3 返回值

成功时dataKey-data定义: 空

成功时rootKey-data定义: 无特殊键值

1.8 刷新登录凭据

为了让用户无需重复登录, 刷新登录凭据API可以让用户通过刷新凭据来刷新登录凭据

1.8.1 请求方式

1.8.2 参数

1.8.3 返回值

成功时dataKey-data定义:

成功时rootKey-data定义: 无特殊键值

1.9 登出

普通网站的登出仅仅是删除本地Cookie, 而InterActivePDK为了增强安全, 设定登出API来禁用当前登录凭据.

由于登出完全可在本地实现, 这里要求前端仅对此API进行调用, 无需处理返回值

1.9.1 请求方式

1.9.2 参数

1.9.3 返回值

只有失败时才有返回值, 如果成功返回值一定是空的

1.10 请求一个新的更改密保邮箱的验证码

这个API用来让已经绑定密保邮箱的用户更改密保邮箱

1.10.1 请求方式

1.10.2 参数

1.10.3 返回值

注: 如果用户没有绑定邮箱, 则会返回错误代码PERMISSION_DENIED

成功时dataKey-data定义:

成功时rootKey-data定义: 无特殊键值

1.11 请求一个新的更改密保手机的验证码

这个API用来让已经绑定密保手机的用户更改密保邮箱

1.11.1 请求方式

1.11.2 参数

1.11.3 返回值

注: 如果用户没有绑定手机, 则会返回错误代码PERMISSION_DENIED

成功时dataKey-data定义:

成功时rootKey-data定义: 无特殊键值

1.12 更改/添加密保邮箱

这个API用来让已经绑定密保邮箱/没有绑定密保邮箱的用户更改/添加密保邮箱

1.12.1 请求方式

1.12.2 参数

1.12.2.1 添加密保邮箱时参数

1.12.2.2 更改密保邮箱时参数

1.12.3 返回值

成功时dataKey-data定义: 无特殊键值

成功时rootKey-data定义: 无特殊键值

1.13 更改/添加密保手机

这个API用来让已经绑定密保手机/没有绑定密保手机的用户更改/添加密保手机

1.13.1 请求方式

1.13.2 参数

1.13.2.1 添加密保手机时参数

1.13.2.2 更改密保手机时参数

1.13.3 返回值

成功时dataKey-data定义: 无特殊键值

成功时rootKey-data定义: 无特殊键值

1.14 请求一个更改密码/忘记密码的验证码

这个API用来让用户请求更改密码/重设密码

1.14.1 请求方式

1.14.2 参数

1.14.2.1 更改密码参数

1.14.2.2 重设密码参数

注: email, phone, username其中必填且只能填一个.

1.14.3 返回值

注: 如果用户没有验证账户或账户被冻结, 会返回PERMISSION_DENIED错误, 且rootKey-data会包含errorReason, 其值为登录失败原因之一.

成功时dataKey-data定义:

成功时rootKey-data定义: 无特殊键值

1.15 更改密码/重设密码

这个API用来让用户更改密码/重设密码

1.15.1 请求方式

1.15.2 参数

1.15.2.1 更改密码参数

1.15.2.2 重设密码参数

注: email, phone, username其中必填且只能填一个.

1.15.3 返回值

成功时dataKey-data定义: 无特殊键值

成功时rootKey-data定义: 无特殊键值

1.16 更改用户信息

这个API用来让用户更改昵称/签名

1.16.1 请求方式

1.16.2 参数

1.16.2.1 更改密码参数

注: nickname,signature,和settings中必填一项, 可同时填写

1.16.3 返回值

成功时dataKey-data定义:

成功时rootKey-data定义: 无特殊键值

1.17 列出已有面具

这个API用来让已登录形随意动用户, 列出他们所拥有的指定(或所有)APP的面具.

1.17.1 请求方式

1.17.2 参数

1.17.3 返回值

成功时dataKey-data定义:

成功时rootKey-data定义: 无特殊键值

1.18 添加面具

这个API用来让已登录形随意动用户, 对一个APPID添加面具.

1.18.1 请求方式

1.18.2 参数

1.18.3 返回值

成功时dataKey-data定义:

1.19 修改面具信息

这个API用来让已登录形随意动用户, 对一个面具进行修改.

1.19.1 请求方式

1.19.2 参数

注: 当display_name项为空(指在JSON数据中无此键值), 或display_name项键值为null, 则不更改原本的display_name, 但如果display_name为’‘或不为空, 则覆盖原本的展示名称

1.19.3 返回值

成功时dataKey-data定义:

成功时rootKey-data定义: 无特殊键值

1.20 删除面具

此API用于让已登录用户删除自己持有的面具.

1.20.1 请求方式

1.20.2 参数

注: DELETE方法的参数用JSON封装在请求体Request Body内

1.20.3 返回值

只有失败时才有返回值, 如果成功返回值一定是空的

2.0 第三方OAuth APP系统

2.1 注册APP

这个API用来让已登录形随意动用户注册APP

2.1.1 请求方式

2.1.2 参数

2.1.3 返回值

成功时dataKey-data定义:

成功时rootKey-data定义: 无特殊键值

2.2 列出已有APP

这个API用来让已登录形随意动用户列出自己已有的APP

2.2.1 请求方式

2.2.2 参数

2.2.3 返回值

成功时dataKey-data定义:

正常返回例子:

{
    "errorCode": 0,
    "data": {
        "apps": [
            {
                "appuid": 1,
                "display_name": "测试程序1",
                "client_id": "b41169f3c1c058863a1f3223ebbc898423f5b827",
                "client_secret": "a03c3e054bd79ad1a2a58d7421f0fbaa953e5c7d",
                "client_type": 3,
                "redirectURI": "",
                "create_time": 1613896746,
                "owner_uid": 23
            },
            {
                "appuid": 2,
                "display_name": "测试程序2",
                "client_id": "b41169f3c1c058863a1f3223ebbc898423f5b827",
                "client_secret": "a03c3e054bd79ad1a2a58d7421f0fbaa953e5c7d",
                "client_type": 3,
                "redirectURI": "",
                "create_time": 1613896746,
                "owner_uid": 23
            }
        ]
    }
}

成功时rootKey-data定义: 无特殊键值

2.3 请求删除APP验证码

这个API用来让已登录形随意动用户请求一个可以删除自己已有APP的验证码

2.3.1 请求方式

2.3.2 参数

2.3.3 返回值

成功时dataKey-data定义: 无特殊键值

成功时rootKey-data定义: 无特殊键值

2.4 删除已有APP

这个API用来让已登录形随意动用户, 且已经发送验证码, 删除自己已有的APP

2.4.1 请求方式

2.4.2 参数

2.4.3 返回值

成功时返回空数据, 请注意检查HTTP返回码.

2.5 请求APP重要操作验证码

这个API用来让已登录形随意动用户请求一个可以进行APP重要操作的验证码(修改信息)

2.5.1 请求方式

2.5.2 参数

2.5.3 返回值

成功时dataKey-data定义: 无特殊键值

成功时rootKey-data定义: 无特殊键值

2.6 修改APP信息

这个API用来让已登录形随意动用户, 且已经发送重要操作验证码, 修改自己已有的APP信息

2.6.1 请求方式

2.6.2 参数

2.6.3 返回值

成功时dataKey-data定义:

正常返回例子:

{
  "errorCode": 0,
  "data": {
    "app": {
      "appuid": 1,
      "display_name": "测试程序1",
      "client_id": "b41169f3c1c058863a1f3223ebbc898423f5b827",
      "client_secret": "a03c3e054bd79ad1a2a58d7421f0fbaa953e5c7d",
      "client_type": 3,
      "redirectURI": "",
      "create_time": 1613896746,
      "owner_uid": 23
    }
  }
}

成功时rootKey-data定义: 无特殊键值

3.0 OAuth前端用API

3.1 获取Auth_Code

此API用于在APP申请Auth Code, 网页跳转到PDK用户系统前端, 用户选择授权的范围并点击授权后, PDK用户系统前端沟通后端发放AuthCode. 所有的重定向都在前端完成.

3.1.1 请求方式

3.1.2 参数

注: 后端会直接拼接参数列表到回调地址, 如果redirect_uri为http://http://localhost:8080/?, 则后端返回的redirect参数为http://localhost:8080/?code=xxx&state=xxx

3.1.3 返回值

成功时dataKey-data定义:

成功时rootKey-data定义: 无特殊键值

4.0 OAuth APP用API

4.1 获取访问令牌APPToken / access_token

此API用于在APP申请Auth Code后, 与后端申请获得access_token用

4.1.1 请求方式

4.1.2 参数

4.1.3 返回值

成功时dataKey-data定义:

成功时rootKey-data定义: 无特殊键值

4.2 验证访问令牌

此API用于在APP申请Access Token后, 与后端沟通验证access_token可用性

4.2.1 请求方式

4.2.2 参数

4.2.3 返回值

成功时dataKey-data定义:

成功时rootKey-data定义: 无特殊键值

4.3 刷新访问令牌

此API用于在APP的Access Token即将过期或已经过期(但刷新令牌没有过期), 与后端沟通刷新access_token

4.3.1 请求方式

4.3.2 参数

4.3.3 返回值

成功时dataKey-data定义:

成功时rootKey-data定义: 无特殊键值

4.4 获取用户基础信息

此API用于在APP拥有Access Token时与后端交互获取用户信息

4.4.1 请求方式

4.4.2 参数

4.4.3 返回值

成功时dataKey-data定义:

成功时rootKey-data定义: 无特殊键值

4.5 发送提醒/营销信息

此API用于在APP拥有Access Token时与后端交互向用户推送信息

4.5.1 请求方式

4.5.2 参数

4.5.3 返回值

成功时dataKey-data定义:

成功时rootKey-data定义: 无特殊键值

5.0 工单系统API

5.1 新建工单

此API让用户/OAuth用户对特定APP(包括PDK)提交工单

5.1.1 请求方式

5.1.2 参数

5.1.3 返回值

成功时dataKey-data定义:

成功时rootKey-data定义: 无特殊键值

5.2 用户列出工单

此API让用户/OAuth用户列出自己所拥有的工单

5.2.1 请求方式

5.2.2 参数

5.2.3 返回值

成功时dataKey-data定义:

成功时rootKey-data定义: 无特殊键值

5.3 回复工单

此API让用户/OAuth用户/APP回复自己所拥有的工单

5.3.1 请求方式

5.3.2 参数

5.3.2.1 用户请求时参数

5.3.2.2 APP请求时参数

5.3.3 返回值

成功时dataKey-data定义:

成功时rootKey-data定义: 无特殊键值

5.4 查询工单信息

此API让用户/OAuth用户/APP查询自己所拥有的工单信息

5.4.1 请求方式

5.4.2 参数

5.4.2.1 用户请求时参数

5.4.2.2 APP请求时参数

5.4.3 返回值

成功时dataKey-data定义:

成功时rootKey-data定义: 无特殊键值

5.5 APP查询拥有的工单数量

此API让APP查询自己所拥有的工单数量

5.5.1 请求方式

5.5.2 参数

5.5.3 返回值

成功时dataKey-data定义:

成功时rootKey-data定义: 无特殊键值

5.6 APP列出已有工单

此API让APP查询自己所拥有的工单数据

5.6.1 请求方式

5.6.2 参数

5.6.3 返回值

成功时dataKey-data定义:

成功时rootKey-data定义: 无特殊键值

5.7 更改已有工单状态

此API让用户/OAuth用户/APP更改自己所拥有的工单的状态

5.7.1 请求方式

5.7.2 参数

5.7.2.1 用户请求时参数

5.7.2.2 APP请求时参数

5.7.3 返回值

成功时dataKey-data定义:

成功时rootKey-data定义: 无特殊键值