API 调用

1.申请API密钥

所有的 API 调用，必须包含 api_id 和 api_secret 两个参数用于授权。申请密钥请联系 support@linkface.cn。

API 密钥是调用Linkface 金融云 API 的重要凭证，请务必妥善保管。如怀疑API 密钥泄露，请及时和对接商务申请重置。

Linkface 金融云 API 全部使用加密的 https 链接，您与我们服务器之间的通信数据完全加密。为了保障您的账号安全请不要关闭客户端的 SSL 证书验证。

2.调用url

接口url前缀：

1. https://cloudapi.linkface.cn
2. http://api.cloud.linkface.cn

开通接口时需选择上述前缀中的一个。本文档中的范例默认使用https://cloudapi.linkface.cn. 对于使用http://api.cloud.linkface.cn的用户，只需要替换对应的前缀即可。

3.API调用

3.1.API调用方法

向服务器发起 HTTP 请求（request），并附上对应的参数； 服务器收到请求后进行相关计算，然后将结果返回（response）；客户端从 HTTP 返回中解析出需要的结果。

Linkface 金融云 API 为 HTTP API，目前的版本并未完全按照 RESTful 风格设计。

3.2.API调用参数

每个 API 在调用时都需要附上特定的参数，以提供算法所需信息。详细参数参见对应的章节。

参数传递方式：

1. POST 请求的 API，在请求体（body）中使用 JSON 格式来编码参数。
2. POST 请求的 API，在请求体中使用 application/x-www-form-urlencoded 格式来编码参数。
3. POST 请求的 API，在请求体中使用 multipart/form-data 格式来编码参数。

例外：当调用 API 上传文件时（例如 /resources/upload_image 中的 file 参数）， 必须使用第 3 种方式提供参数，并且需要提供的是文件内容，而不是文件名。

3.3.API调用工具

调用API 使用 POST 请求。若使用浏览器调用，请为浏览器安装支持其他 HTTP 方法的插件

推荐两个命令行工具：cURL (http://curl.haxx.se/) 和 HTTPie (http://httpie.org/)，命令格式请参阅各自文档。

3.4.API调用说明

• 若将 URL 放入 Query String 中则需要对特殊字符进行转义，所有中文和特殊字符必需以UTF-8编码转义。

• 支持 http/https 等协议的网络地址。下载限时 5s，超时后仍未下载完成则属于失败。

• 打开自动旋转功能会增加运算时间,请酌情考虑是否开通此功能

4.API调用限制

由于前端调用 API 时，极有可能造成密码泄露，为保证您的账号安全，系统不支持前端调用。

为防止滥用，本服务对用户调用 API 的频率有所限制，参见下一小节 API 返回处理 中的 超过调用限制 部分。