API接入流程


WorkPlus平台作为企业移动应用的统一入口,提供了用户身份集成,应用接入等基础能力接口。第三方应用主动调用接口时,需带上AccessToken参数。AccessToken参数由DomainId,OrgId,AppKey,AppSecret获取。具体需要以下步骤:

  1. 以组织管理员身份登录后台创建应用,并获取DomainId,OrgId,AppKey及AppSecret等信息。
  2. 通过DomainId,OrgId,AppKey及AppSecret获取AccessToken。
  3. 通过AccessToken调用相关接口。

获取AppKey及AppSecret等信息

登录管理后台 > 创建应用;填写应用相关信息后,可以获取到AppKey及AppSecret等信息,如下图:

appkeys

获取AccessToken

通过DomainId,OrgId,AppKey及AppSecret调用以下接口获取AccessToken:

POST

https://api3.workplus.io/v1/token

请求头部

请求头 说明
Content-Type application/json

请求格式

{
  "grant_type": "client_credentials",
  "scope" : "app",
  "domain_id" : "DomainId",
  "org_id" : "OrgId",
  "client_id" : "AppKey",
  "client_secret" : "5tAkUIt1rrnP0WNLg7BWYuuqwzn3xRoO"
}

返回数据

application/json
{
    "status": 0, 
    "message": "Everything is ok.", 
    "result": {
        "access_token": "7447497d58de4d55879ce1e441a101e4", 
        "refresh_token": "02a639c9bffc4640aa5045ded3902a31", 
        "issued_time": 1484882719965, 
        "expire_time": 1487474719965, 
        "client_id": "92bc3faa-12bd-4afc-9962-01f2410f0bee"
    }
}

成功返回字段说明

字段 类型 说明
client_id String 当前登录用户的标识
access_token String 应用的身份凭证
refresh_token String 更新身份凭证
issued_time String access_token的生效时间
expire_time String access_token的过期时间

错误返回值

status message 说明
202102 没有对应的应用 没有对应的应用
202104 应用认证失败 应用认证失败

results matching ""

    No results matching ""