接入指南
第一步:依据接口文档实现业务逻辑
获取凭证
办公逸提供API支持办公逸与第三方软件/服务集成,集成操作需要可用的用户身份验证凭证,用户需要拥有"办公逸API访问"权限以访问API。
生成身份验证凭证
进入到开发者设置界面,在调用凭证选项卡,生成并查看自己的凭证。 如图:
通过身份凭证调用不同接口
获取凭证之后,就可以使用获取的凭证,调用办公逸接口获取数据
第二步:填写服务器配置
登陆办公逸后台,进入开发者设置配置服务器(企业帐号->开发者设置),如图:
第三步:验证服务器地址的有效性
进入到开发者设置界面,在接口设置选项卡配置服务器,办公逸将要求您填写服务器URL,token两个参数。 URL是企业应用接收办公逸推送请求的访问协议和地址,支持http或https协议。 token可由企业任意填写,用于生成签名。
当你提交以上信息时,办公逸将发送GET请求到填写的URL,GET请求将携带四个参数,
参数 | 描述 | 是否必带 |
---|---|---|
signature | 办公逸签名,signature结合了企业填写的token, 请求中的timestamp,nonce参数 |
是 |
timestamp | 时间戳 | 是 |
nonce | 随机数 | 是 |
echostr | 随机数 | 是 |
企业通过传递的参数进行验签,如果确认此次GET请求来自办公逸,那么企业应返回echostr(不能加引号,不能带bom头,不能带换行符),则接入验证生效。 后续推送企业时都会在请求URL中带上以上参数(echostr除外),校验方式与首次验证URL一致。
关于签名
办公逸为了验证企业填写URL的合法性,办公逸在推送的URL中增加了签名,以参数signature进行标记,企业需要验证此签名的正确性后在进行相关逻辑操作。验证步骤:
- 企业签名算法:c_signature = sha1(sort(token,timestamp,nonce)),sort的含义是将参数按照字母字典排序,然后从小到大拼接成一个字符串
- 比较c_signature 和 signature是否相等,相等则表示验证通过
- 示例下载