Skip to main content

01 访问凭证获取

1.1 公有云使用

DocFlow使用TextIn账号。 请在TextIn上注册后,在 TextIn首页-账户与充值-账号与开发者信息 页面获取 x-ti-app-idx-ti-secret-code,用于请求认证。

1.2 私有云使用

请联系对接的技术支持人员,获取用于私有化部署的API调用凭证。

02 请求认证

DocFlow接口支持两种请求认证方法:
  1. 简易认证。该方法简单,但安全性有限,通常用于快速集成以体验DocFlow流程和效果。
  2. 签名认证。该方法复杂,但安全性较高。可以避免访问凭证被中间人获取和篡改请求。

2.1 简易认证

x-ti-app-idx-ti-secret-code 作为 HTTP 头来认证。 示例:

2.2 签名认证

以签名方式认证请求,需要传入3个 HTTP Header:

签名计算

签名计算方法为:
其中:
  1. lower() 为字母转小写函数
  2. hex()将字节数组转为16进制字符串
  3. HMAC_SHA256 为密码哈希函数,可以参考各开发语言库
  4. signing_key = HMAC_SHA256(x-ti-secret-code, epoch)。其中x-ti-secret-code为TextIn开发者凭证。 epoch为Unix Epoch时间戳(秒)。
  5. string_to_sign,下文详细说明
string_to_sign
string_to_sign 由是以下内容拼接而成的字符串:
其中:
  1. HTTP方法为大写,例如GETPOST
  2. 请求URL,URL中的路径部分(不含协议和域名),例如/api/app-api/sip/platform/v2/file/upload
  3. URL参数排序,是对所有请求参数按参数名的字典序( ASCII 码)升序排序。参数值不参与排序。例如: 假设参数是workspace_id=12345&batch_num=54321&file_name=invoice.pdf, 排序后结果是batch_num=54321&file_name=invoice.pdf&workspace_id=12345 注意:
    1. 参数值在进行签名计算时,不需要 url 编码
    2. 参数以 & 拼接,最后没有&
示例: