开发工具

获取 App 详情

GET

/sdk/v2/api/license/apps/{appId}

用于获取 App 详细信息，包括 app 名称、可使用文件类型、已激活用户数、用户总数、席位数、license 有效时间、回调地址信息。

提示

由于“App 管理”相关的接口的特殊性，为了安全考虑，需要在生成签名时附加上 "scope": "license" 字段。

请求参数

Path 参数

appId

string

必需

示例值:

Header 参数

X-Shimo-Signature

string

必需

示例值:

X-Shimo-Token

string

必需

示例值:

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request GET 'https://office.shimoapi.com/sdk/v2/api/license/apps/' \
--header 'X-Shimo-Signature: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImZkZWEwODk5NTYwMzRkMzliOWZjYmZmOTg1M2NhYWZiIn0.eyJleHAiOjE3NDAwMTk1MDF9.wBfjvKigaNDeRldcKlJLr6FFHRGw50q7RYfuYb7Jy5U' \
--header 'X-Shimo-Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImZkZWEwODk5NTYwMzRkMzliOWZjYmZmOTg1M2NhYWZiIn0.eyJ1c2VySWQiOjQ5LCJtb2RlIjoic2hpbW8iLCJleHAiOjE3NDAwMTk1MDF9.Ta124wvF-lbpge6Ytah-7LyasBfu0SnZgDyu3GuwXDM'

返回响应

🟢200成功

application/json

Body

appName

string

app名称

必需

availableFileTypes

array[string]

可用的文档类型

必需

activatedUserCount

integer

已激活用户数

必需

userCount

integer

总用户数

必需

memberLimit

integer

总席位数

必需

validFrom

string

有效期开始时间

必需

validUntil

string

有效期截止时间

必需

endpointUrl

string

回调地址

必需

示例

{
    "appName": "myAppName",
    "availableFileTypes": [
        "document",
        "documentPro",
        "spreadsheet",
        "presentation",
        "table",
        "form"
    ],
    "activatedUserCount": 115,
    "userCount": 129,
    "memberLimit": 1000,
    "validFrom": "2023-12-21T03:39:11Z",
    "validUntil": "2123-11-27T03:39:11Z",
    "endpointUrl": "http://my-endpoint-url.com/callback"
}

App 管理

更新 App 回调地址