备注

本文档主要介绍调用海为云企业平台 API 的请求结构和请求示例。

开发前须知

注意事项

1. 在调用 HaiwellAPIs 前，确保已获取 API 访问凭证，并加入到请求 Header 中。

2. 在调用服务端 API 前，确保你已了解调用频率限制。

3. 查询服务端错误码表，了解排查建议。

4. 可以使用 Postman 进行接口调试和示例代码查看。

APIs 协议说明

• Protocols： HTTPS
• Host： openapi.haiwell.com
• prefix： /api
• Version： v1
• Accepts： application/json
• Responds With： application/json

请求地址

所有的 API 请求都必须通过 HTTPS 发出，请求的基础 URL 格式为：{{Protocols}}://{{Host}}/{{prefix}}/{{Version}} + 具体 API 请求地址。

示例

https：//openapi.haiwell.com/api/v1/users/token

请求参数

每次请求 API 时，均需提供 2 个请求公共请求参数，具体如下：

参数	参数类型	数据类型	是否必需	描述
Authorization	Header	String	是	访问凭证。格式为：Bearer [ACCESS TOKEN]
Client-ID	Header	String	是	开发者 clientID（开发者中心应用密钥）

请求方式

HTTPS 请求方法（也称为操作），它告诉服务你正在请求什么类型的操作。

方法	说明
POST	请求服务器新增资源或执行特殊操作。
GET	请求服务器返回指定资源。

请求头部示例

Authorization: Bearer [ACCESS TOKEN]
Client-ID: SK1568693976264

API 调用流程说明

应用申请访问凭证和发起请求的流程如下：

1. 第三方应用服务器向 Haiwell API 服务器发起申请访问 token 请求并且携带 clientID 和 secret

2. API 服务器验证 clientID 和 secret 信息是否正确

3. 验证成功后返回访问 token

4. 第三方应用服务器发起业务请求，并且携带访问 token

5. API 服务器验证是否存在访问令牌，然后验证访问令牌的有效性。

6. 转发请求给 Haiwell 业务服务器

7. Haiwell 业务服务器将处理后的结果返回给 HaiwellAPI 服务器

8. HaiwellAPI 服务器将响应结果透传给第三方应用服务器