此产品的文档集力求使用非歧视性语言。在本文档集中，非歧视性语言是指不隐含针对年龄、残障、性别、种族身份、族群身份、性取向、社会经济地位和交叉性的歧视的语言。由于产品软件的用户界面中使用的硬编码语言、基于 RFP 文档使用的语言或引用的第三方产品使用的语言，文档中可能无法确保完全使用非歧视性语言。 深入了解思科如何使用包容性语言。
思科可能会在某些地方提供本内容的当地语言翻译版本。请注意，翻译版本仅供参考，如有任何不一致之处，以本内容的英文版本为准。
API Explorer 为 REST API 提供了一个限制接口，并提供了 REST API 的功能视图。
API Explorer 位于 管理中心上，可通过以下位置的 管理中心 访问：
https://<management_center_IP_or_name>:<https_port>/API/API-explorer
版本 6.4 使用基于 OpenAPI 规范 (OAS) 的 API Explorer。如果愿意，您仍然可以访问旧版 API Explorer。
作为 Open API 规范的一部分，您可以使用 CodeGen 生成示例代码。CodeGen 是 Swagger 提供的一种实用工具，可根据 Open API 规范生成 API 客户端库和代码。有关更多信息，请参阅“使用 Code Gen 获取代码”。
此管理器提供了 管理中心 上可用的 API 列表及其详细信息。
请注意，在 CDO 中，API Explorer 在 CDO 平台上运行，对 API Explorer 进行的任何调用都会影响云交付的 管理中心。
REST API 采用与 管理中心相同的身份验证方法。REST API 中的每个功能都与 管理中心内的权限相对应。
您可以使用 管理中心内的任何帐户登录到 API Explorer，但只能执行该帐户具有相应权限的功能。有关为用户角色设置权限的详细信息，请参阅《Firepower 管理中心配置指南》。一个帐户不能同时使用 REST API 界面（包括 API Explorer）和用户界面，当登录一个帐户时，另一个帐户会注销另一个帐户，而不会发出警告。因此，思科建议为用户界面和 REST API 分别使用不同的帐户。
第一次连接到 API Explorer 时可能会收到一个错误，指出因证书无效而导致连接不安全。您需要在浏览器中添加一个例外项才能使用该证书并接受连接
REST API 使用与 管理中心相同的身份验证和权限模式。有关详细信息，请参阅《Firepower 管理中心配置指南》。
确保您在 管理中心的帐户拥有执行需要使用 REST API 才能执行的任务所需的权限。
|
步骤 1 |
导航到以下 URL：https://<management_center_IP_or_name>:<https_port>/api/api-explorer 如果您在使用 Firefox 浏览器时遇到登录屏幕长时间加载的问题，请在搜索栏中输入 about:support，并点击 Refresh Firefox 选项，然后在同一 Firefox 浏览器窗口中使用自签名证书查看 管理中心界面。有关详细信息，请参阅 https://support.mozilla.org/en-US/kb/refresh-firefox-reset-add-ons-and-settings。 |
|
步骤 2 |
用您的用户名和密码登录，然后点击 "Sign In" |
找到所需的资源和请求。
REST API 可以全局、在默认域或特定域中执行功能。
您必须有一个已配置的 管理中心，并且必须有一个账户可以有权访问在您的 管理中心 上配置的一个或多个域中的 REST API。
|
下拉右下方的 |
找到所需的资源和请求类型。
API Explorer 已针对 6.4.0 进行了更改。虽然较新的 API Explorer 保留了几乎所有以前的功能，但有些用户可能更喜欢旧版界面。
 注 |
旧版 Explorer 将在 管理中心的未来版本中删除。请使用 Open API 规范在将来访问当前 REST API 功能。 |
确保您在 管理中心的帐户拥有执行需要使用 REST API 才能执行的任务所需的权限。
登录到 API Explorer，网址为：https://<management_center_IP_or_name>:<https_port>/api/api-explorer。
|
在右上角点击 |
您就可以像往常一样使用旧版 API Explorer。
您可以使用 Open API 规范的 CodeGen 实用程序，以多种语言生成示例代码。此实用程序是开源工具，您可以在线下载。生成的代码主要作为教育和引导程序工具。
CodeGen 实用程序为整个 Open API 规范创建示例代码。因此，它会在 REST API 中为每个允许的方法和端点生成示例代码。示例代码可采用多种语言，包括 HTML、Perl、Python 和 Java。
有关 CodeGen 实用程序的完整文档，请访问 https://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/
Open API 规范是 REST API 的标准化规范。管理中心 REST API 的 Open API 规范包含有关 API 端点、字段、参数和要求的详细信息。您可以使用 API 规范生成示例代码以及查找有关 API 功能的特定信息。
Open API 规范是一个 JSON 文件。大多数文本编辑器都可以读。
在能够访问 API Explorer 的 管理中心拥有帐户。
请确保您的浏览器能够从具有自签证书的站点下载。
|
步骤 1 |
按照登录 API Explorer中的步骤打开 API Explorer |
|
步骤 2 |
在右上角中点击 |
|
步骤 3 |
保存文件。确保记下目标和文件名。 |
在下载的文件上运行 CodeGen 实用程序。
Swagger CodeGen 实用程序允许您通过 Open API 规范生成示例代码。此示例代码可采用多种语言，包括 Java、HTML、Python 和 Perl。
下载 Swagger CodeGen 实用程序。请参阅使用 CodeGen 获取示例代码。
在您的计算机上安装 Jave 运行时环境
下载 管理中心 REST API Open API 规范。请参阅下载 Open API 规范。
设置环境变量以允许您运行 CodeGen 实用程序
|
从命令行，运行命令 示例:
|
在输出路径中查找生成的代码并根据需要使用。生成的代码应视为示例，并且可能不会按预期执行，除非经过修改以满足您的需要。
每个资源都有一组与之关联的参数和字段。您可以通过在 API Explorer 中执行该资源支持的任何操作来查看参数和字段。
您必须有已配置的 管理中心，并且您在该管理中心的帐户必须拥有所需的权限，才能使用所需的 REST API 功能。
|
步骤 1 |
打开 API Explorer。请参阅登录 API Explorer。 |
|
步骤 2 |
选择所需的资源。 |
|
步骤 3 |
为该资源选择一个受支持的操作。 |
反馈