开始开发
开发初始步骤
您可以通过一下步骤,获取access_token令牌,使用这个令牌来访问Hippius的接口.需要注意的是,所有的接口需使用Https协议、Json数据格式、UTF8编码。 注:查看接口说明中,参数中标注大写的单词,表示为需要替换的变量。
第一步: 创建企业并获取CorpID和CorpSecret
使用平台管理员在企业管理
>企业管理
页面创建企业,如果没有平台管理员账号,请联系我们
使用新建的企业管理员在企业管理
>企业信息
>企业信息
页面查看对应的corpId
和 corpSecret
第二步:使用接口获取access_token 令牌
无需用户登录,只获取 access_token,用于调用hippius系统的接口
请求方式:POST(https)
请求url:https://{ip}//oauth/oauth/token?grant_type=client_credentials&client_id=CORPID&client_secret=CORPSECRET
此处标注大写的单词CORPID和CORPSECRET,为需要替换的变量,根据实际获取值更新。其它接口也采用相同的标注,不再说明
参数说明
参数 | 必须 | 说明 |
---|---|---|
grant_type | 是 | 固定值:client_credentials |
client_id | 是 | 第一步中的corpId |
client_secret | 是 | 第一步中corpSecret |
返回结果:
{
"access_token": "2cd8b43b-cddb-4603-aeef-7c8849548501",
"token_type": "bearer",
"expires_in": 3600,
"scope": "default"
}
字段解释
参数 | 说明 |
---|---|
access_token | 令牌,身份凭证 |
expires_in | 令牌有效时间 |
第三步:access_token的缓存和刷新
开发者需要缓存access_token,用于后续接口的调用(注意:不能频繁重新调用接口获取,否则会受到频率拦截)。当access_token失效或过期时,需要重新获取。
- access_token的有效期通过返回的expires_in来传达,正常情况下为7200秒(2小时),有效期内重复获取返回相同结果并且自动续期,过期后获取会返回新的access_token。
- access_token至少保留512字节的存储空间。
- Hippius可能会出于运营需要,提前使access_token失效,开发者应实现access_token失效时重新获取的逻辑。
第四步:初始化企业通讯录数据
参考:同步部门员工数据
第五步:开发应用逻辑
到这里,准备工作已经就绪,你可以继续阅读下面的接口文档了解更多关于Hippius提供的开放能力,并将这些能力与你的应用进行结合。