使用Cato站点创建API与Postman

本文解释了如何使用Postman API客户端并执行Cato的API以在Cato管理应用程序中配置站点。

配置Postman概述

这是关于配置Postman以运行Cato配置API以配置和更新站点的高级概述。

  1. 从Cato管理应用程序生成API密钥。

  2. 下载并导入Postman Collection和Environment。

  3. 配置环境。

  4. 运行API并在账户中配置站点。

从Cato管理应用程序生成API密钥

API密钥是API客户端用于与您的Cato账户进行认证的代码。 您可以使用Cato管理应用程序中的API管理屏幕生成具有编辑权限的API密钥。

API Keys.png

为Cato创建API生成API密钥：

  1. 在导航菜单中，点击资源 > API密钥。

  2. 在API密钥选项卡上，点击新建。 创建API密钥面板打开。

    image2.png

  3. 输入密钥名称。

  4. 将API权限设置为编辑。

  5. 我们建议设置API密钥过期时间的日期。

  6. 点击应用。 API密钥已添加并显示包含新API密钥的弹出窗口。

  7. 点击copy.png (复制)并复制由Cato管理应用程序生成的API 密钥，并将其保存到安全位置。

    关闭此窗口后，您将无法访问API密钥的值。

    image3.png

  8. 点击确定关闭弹出窗口。

将Cato API集合和环境添加到Postman中

我们创建了一个自定义Postman集合和环境，帮助您开始使用Cato创建API进行站点配置。 这些自定义文件可在Cato存储库中找到。

  • _cato_env_template_.postman_environment.json
  • 配置API的变更API文件（例如Cato站点变更API v1.postman_collection.json）

Postman环境包含变量（API URL、CMA账号ID等），而Postman集合包含GraphQL变更API调用的示例。 要导入它们，点击“导入”，将文件拖入窗口并点击导入：

要将Cato API的集合和环境添加到Postman：

  1. 从本文知识库文章中下载自定义集合和环境到您的设备。

  2. 从Postman选择文件 > 导入。 导入弹出窗口开启。

  3. 点击上传文件，然后选择在第1步中下载的文件。

    Import_Files.png

  4. 点击导入。

自定义环境现在显示在Postman的环境中：

image6.png

自定义集合现在显示在Postman的集合中：

image7.png

配置Postman环境

我们建议您为每个Cato租户使用一个单独的Postman环境，在其中存储CMA账号ID和API密钥。

创建新的Postman环境：

  1. 从环境标签页，右键单击模板_cat_env_template_，并选择复制。

    image8.png

  2. 右键单击环境的副本，选择重命名，然后将环境重命名为您的Cato租户名称。

    image9.png

  3. 复制API密钥和CMA账号ID，并将它们粘贴到环境中相关字段的当前值中，然后点击保存。

    image10.png

    您可以直接从URL中检索CMA账号ID：

    image11.png

运行Cato API调用来配置站点

在为Postman定义API密钥和CMA账号ID之后

执行API调用并配置站点：

  1. 在集合选项卡上。

  2. 在右上角，选择您在上一步中创建的环境。

    image12.png

  3. 从集合选项卡，展开Cato变更API v1 > addSocketSite > _query并选择query_stateCode。

    image13.png

  4. 点击发送以执行API调用。 预期结果为200 OK和一些数据。

    image14.png

这篇文章有帮助吗？

1 人中有 1 人觉得有帮助

0 条评论