Kaizala API 文档

  • 项目

在开始之前，请参阅 使用 Kaizala 连接器的安装程序

根域

用于调用 Kaizala API 的根域是：

{endpoint-url}
参数 类型 选？ 说明
终结点 URL endpoint-url 字符串 否 在生成访问令牌时成功进行身份验证时，将返回一个终结点 URL，该 URL 应用作 api-base-url 进行后续 API 调用

点击任何 Kaizala API 时，可以获取 Http 状态代码：308，指示用户的终结点 URL 已更改。 在这种情况下，响应标头位置将包含新的 endpoint-url。

建议： 客户端可以将超时配置为在 1 分钟时接收来自 Kaizala API 的响应

API 终结点

Kaizala API 在安全的 Microsoft Azure 云上运行，并与 Kaizala 平台交互，为最终用户执行各种操作。 该 API 适用于以下 Kaizala 资源：

Kaizala API 的限制限制为

  • 每个连接器每分钟 100 个调用
  • 每个租户每分钟 300 次调用， (跨连接器)

超过限制限制时，API 将返回“重试后”值以及 Http 状态代码：429。 “Retry-After”值指定在发出另一个请求之前要等待的秒数。

WebHook

Microsoft Kaizala API 还为开发人员提供了一种通过 WebHook 在 Kaizala 平台中注册特定事件的方法。

Postman 集合

为了测试 API 并了解 Kaizala API 架构，可以导入 postman 集合，其中包含所有 Microsoft Kaizala API 的示例和架构：

在 Postman 中运行

在运行 postman 项目之前，请在“Kaizala-API-environment”中设置以下环境变量：

  • mobile-number：将用于调用 API 的手机号码
  • application-id：与连接器关联的 ID
  • application-secret：与连接器关联的机密

在 Postman 项目中尝试按顺序提及的 API 时，会自动填充其他环境变量。

Kaizala REST API 入门

C# 示例 (共享)