跳转至主要内容

API和Webhooks

您可以通过API SmartLink和Webhooks将SmartLink集成到任何软件中（如LDAP、SOC、Google Suite等）！

这些功能仅适用于白金和企业许可证。

API SmartLink允许您向您的SmartLink发出请求（例如：获取应用程序、创建用户等）以进行集成。

Webhooks允许在触发事件时将数据发送到您选择的URL（例如：创建用户、用户登录等）。

Webhooks​

访问Webhooks选项卡​

从侧边栏导航中转到配置，然后选择Webhooks选项卡。

前往配置，然后选择Webhooks选项卡

01.webhooks-tab-overview

Webhooks文档​

单击此处查看SmartLink Webhooks的完整文档（可用事件列表、有效负载格式等）

单击打开SmartLink Webhooks文档链接以访问完整的Webhooks文档：包括可用事件列表、有效负载格式和集成示例。

添加端点​

单击工具栏中的添加端点按钮以配置新的Webhook。

单击添加端点以配置新的Webhook

会打开一个侧边栏，其中包含配置表单。

04.add-endpoint-form

配置端点​

目标URL​

输入您的端点URL。SmartLink将通过HTTP POST将事件发送到此地址。

输入您的端点URL。SmartLink将通过HTTP POST将事件发送到此地址。

要监听的事件​

选择要接收的事件（例如：用户创建、用户登录等）

选择要接收的事件。您可以同时选择多个事件。

API​

访问API选项卡​

在配置页面的API选项卡中，您可以启用对SmartLink REST API的访问。

07.api-tab---disabled

默认情况下，API处于禁用状态。

API当前状态的横幅。这里API被禁用了。

启用API​

在工具栏中切换此开关以启用SmartLink API

在工具栏中切换启用API开关以启用对API的访问。

10.api-tab---enabled

启用API后，您的API密钥将显示。

API密钥​

API密钥默认隐藏。将鼠标悬停在其上以显示。

API密钥默认隐藏。将鼠标悬停在其上以显示。

复制密钥​

单击复制以将API密钥复制到剪贴板

单击复制以将API密钥复制到剪贴板，然后在您的集成中使用。

重新生成密钥​

单击重新生成以生成新的API密钥。旧密钥将立即失效。

单击重新生成以生成新的API密钥。旧密钥将立即失效，请记得更新所有集成。

API文档​

单击此处打开SmartLink API的交互式文档（Swagger）

单击打开SmartLink API文档以访问交互式文档（Swagger），列出所有可用的端点。

15.api-documentation-page