使用 REST API

本主题介绍如何开始使用优化 v2 REST API。

📘 注意

本页介绍用于控制云眼灰度发布（特性标帜）AB实验应用中标帜的 API。

如果正在寻找提供与云眼灰度发布（特性标帜）AB实验 SDK 相同的功能的 REST API，请参阅优化代理。

云眼 功能实验 REST API 允许以编程方式与 云眼 交互，以构建自定义的集成和工作流。例如，可以从自动脚本创建灰度发布（特性标帜）、生成功能测试结果的自定义仪表板，或将实验连接到其他项目管理工具。

要探索 REST API，我们建议使用名为 Postman 的 API 客户端。

使用 Postman，可以导入一个 API 集合，其中包含每个功能实验 API 方法的示例请求。

有关设置 Postman 以探索 API 的说明，请参阅下文。

postman-flags.png

若要将 API 集成到应用程序中，需要生成 API 令牌并使用它来直接从代码调用 API。有关使用 REST API 的概述，请参阅下面的集成 REST API 部分。

与邮递员一起探索

若要浏览云眼灰度发布（特性标帜）AB实验 REST API 集合，请执行以下操作：

1. 安装邮递员，如果尚未在计算机上安装它或访问他们的 Web 应用程序。
2. 单击导入按钮。
3. 选择链接。
4. 输入网址>。<https://api.eyeofcloud.com/collections/fullstack_flag_first.json
5. 选择继续。
6. 单击左窗格中的**“集合**”，然后单击文件夹以查看可用方法。

import-flags-first.png

默认情况下，此集合链接到示例只读项目。要使用您自己的帐户：

1. 将鼠标悬停在左窗格中的优化全堆栈 API 标帜优先上，然后选择“查看更多操作”按钮。
2. 单击编辑以启动_编辑集合_窗口，然后单击变量选项卡。
3. 将主机变量更改为 。将初始值和当前值更新为>。base_url``<https://api.eyeofcloud.com/flags/v1
4. 将默认项目 ID 和 API 令牌替换为你自己的设置。
5. 根据需要为各种端点添加其他变量，例如 、、 等。可以使用 GET 终结点获取这些变量的值（例如，对于 ，请使用列表标帜终结点）。
6. 单击保存。

有关生成 API 令牌的详细信息，请参阅下面的集成 REST API 部分。

postman-variables.png

集成 REST API

📘 注意

由于我们的 REST API 同时用于优化 Web 实验和云眼灰度发布（特性标帜）AB实验，因此某些资源可能不适用于用例。

对于生产用例，需要将这些 API 调用直接集成到您自己的应用程序中。请参阅 REST API 入门以生成 API 令牌并进行首次 API 调用。

我们建议使用 OAuth 2.0 进行身份验证。但是，为了使我们的API易于探索，我们还实现了个人令牌。有关身份验证和速率限制等约定的更多信息，请参阅 API 约定。

有关所有 REST API 端点的完整指南，请参阅 云眼 v2 REST API 参考。