SD-WAN Orchestrator API 指南

要在 Swagger UI 上访问 SD-WAN 协调器 API 指南,您需要使用 API 密钥对自己进行身份验证。以下过程提供了有关生成 API 密钥并将其用于身份验证的说明。

  1. 登录到您的 Citrix Cloud 帐户,然后导航到“身份识别和访问管理”>“API 访问”。

    注意

    如果您是代表客户执行 API 的合作伙伴,请使用“更改客户”选项登录客户的 Citrix Cloud 帐户 ,或从客户那里获取身份验证和相关 API 参数。

    身份识别和访问管理

    创建安全客户端

  2. 为您的安全客户端提供一个名称,然后单击 创建客户端。将生成 ID 和密钥。使用 API 管理您的网络时,使用 ID 和密码对自己进行身份验证。

    注意

    下载 ID 和秘密并安全存储。关闭窗口后无法访问密码。

    ID 和密码

    注意

    出于安全考虑,建议您在使用完 API 后从 Citrix Cloud 中删除 API 密钥项。

    ID 和密码

  3. 登录 SD-WAN Orchestrator,然后单击 UI 右上角的 API 图标。

    API 图标

    此时将显示 Swagger 规格详细信息。

    API 图标

  4. 单击 Swagger 规范 URL 以访问 API 指南。

  5. 在 API 页面中,导航到 auth-controller > /{ccId}/api/v1/logon > 试用

    身份验证 Controller

  6. 从 SD-WAN Orchestrator Swagger 规格详细信息中,复制 Citrix Cloud ID 并将其粘贴到 Citrix Cloud 用户 ID 下的文本框中。

  7. 同样,在相应负载字段中复制并粘贴客户端 ID、客户端密钥和 Citrix Cloud ID,然后单击 执行

    API 有效负载

  8. 服务器响应 中复制 令牌值。

    服务器响应

  9. 单击 API 页面顶部的 授权 ,然后将 令牌 值粘贴到 字段中。单击 Authorize(授权)。

    授权

    API 密钥

这就完成了授权过程,您现在应该能够访问和使用 SD-WAN Orchestrator API。

SD-WAN Orchestrator API 指南