Skip to content

获取用户常用应用

适用版本>=v7.0.2412b.20241226

接口说明:获取用户常用应用

请求说明

请求地址配置域名+/openapi+/v7/get_workbench_favorite_apps
请求方法GET
签名方式KSO-1(配置域名+/openapi不参与签名)
权限要求查询应用信息(用户授权) kso.app.read

请求头(Header)

Header参数类型是否必填说明
Content-Typestring使用 application/json
X-Kso-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}

查询参数(Query)

名称参数类型是否必填说明
page_tokenstring分页标记
page_sizeinteger分页大小

响应体(Response)

名称类型说明
codeinteger响应结果标识
msgstring错误信息描述
dataobject响应数据
next_page_tokenstring分页标记(365 规范)
itemsarray应用数据
idstring应用id
namestring应用名称
typestring官方应用(official)、企业自建应用(company_internal)、ISV应用(isv)
descriptionstring应用描述
logostring应用图标 (返回的是一个url)
i18narray国际化
lang_codestring语言类型:繁体中文,英文,日文,泰文。("zh-TW","en-US", "ja-JP" ,"th-TH" )
namestring应用名称
descriptionstring应用描述
settingsarray应用设置
single_itemobject字符串类型的应用设置
keystringpc_xz_homepage_open (pc端打开模式); pc_xz_homepage(pc端主页); mobile_xz_homepage(移动端主页)
valuestringpc端打开模式: app, external_browser; url
categoryarray应用分组
namestring应用分组名称
idstring应用分组id

响应体示例

json
{
  "data": {
    "items": [
      {
        "category": null,
        "description": "打卡",
        "i18n": [
          {
            "description": "",
            "lang_code": "zh-TW",
            "name": ""
          },
          {
            "description": "",
            "lang_code": "en-US",
            "name": ""
          },
          {
            "description": "",
            "lang_code": "ja-JP",
            "name": ""
          },
          {
            "description": "",
            "lang_code": "th-TH",
            "name": ""
          }
        ],
        "id": "woa-attendance-assistant",
        "logo": "DD1AFB29d29hL2M3ZmQ4OWI3YTQyZDc0NGJlNWI0YTNkZWNhMjY2YmRhOndwczM6d29hOjE=",
        "name": "打卡",
        "settings": [
          {
            "single_item": {
              "key": "pc_xz_homepage_open",
              "val": "app"
            }
          },
          {
            "single_item": {
              "key": "pc_xz_homepage",
              "val": ""
            }
          },
          {
            "single_item": {
              "key": "mobile_xz_homepage",
              "val": ""
            }
          }
        ],
        "type": "official"
      }
    ]
  },
  "msg": "成功",
  "code": 0
}