跳到主要内容

APIM Developer Portal User Guide

介绍​

在本指南中，包含用户在 APIM 开发者门户中可以执行的任务的详细信息。

创建我的应用程序​

首先，用户需要了解如何创建一个应用程序。

什么是应用程序？​

一个 Application 代表用户的服务或系统，用于开发或操作。通过它，用户可以发放 API 密钥、API URL、请求访问 API，并通过 Swagger 测试 API。

创建应用程序的步骤​

  • 转到全局菜单 > 应用程序 > 我的应用程序

  • 在我的应用程序屏幕上点击“创建”按钮。

  • 输入新应用程序的名称（允许使用韩文、英文和空格）。
  • 点击“确认”以创建应用程序。

我的应用程序​

这是用户的工作区。您可以添加成员，请求 API 访问，通过 Swagger 测试，并管理 API 密钥。

屏幕组件：

  • Basic Information: 设置应用程序名称和图标；删除未使用的应用程序。
  • API KEY: 在 API 调用期间用于身份验证。创建时自动发放；可以由应用程序管理员重新发放。
  • API Usage: 通过选择 API 并描述使用意图请求访问 API。一旦获得批准，您将收到 API URL。
  • Member Management: 添加成员并分配应用程序管理员权限。
  • IP/Referer Whitelist: 限制 API 调用仅限于特定的 IP 或白名单中的引用，阻止其他请求。

我的应用程序 - 基本信息​

管理应用程序名称和图标，并可选择删除该应用程序。

要点：

  • 前往“基本信息”查看详细信息。
  • 检查应用程序名称、AppID 和创建日期。
  • 编辑应用程序名称。
  • 设置或更改应用程序图标。
  • 保存更改。应用程序管理员可以删除该应用程序。

我的应用程序 - API 密钥​

这指的是在调用 API 时用于身份验证的 API 密钥。它在创建应用程序时自动发放，应用程序管理员可以重新发放它。

危险

在调用 API 时必须使用 API 密钥。否则，API 调用将失败，因为没有身份验证。

要点：

  • 访问 API 密钥菜单。
  • 查看在应用程序创建时发放的初始 API 密钥。
  • 在调用 API 时，将其设置在 HTTP 请求头中，如下所示：
x-apim-key: "xxxxxxxx"

我的应用程序 - API 使用​

选择您想要使用的 API，输入使用 API 的目的，并请求使用该 API。如果请求获得批准，您将收到一个 API URL，允许您调用该 API。

要使用 API，请按照以下步骤操作：

  • 通过菜单前往“API 使用”屏幕。
  • 通过点击“添加”按钮选择您想要请求使用的 API。

  • 在“使用批准请求”弹出窗口中，通过勾选复选框选择要使用的API。可以进行多项选择。
  • 输入使用目的/描述。
  • 点击“确认”提交请求（状态将设置为“待处理”）。

以上是请求API使用后的屏幕，显示API使用请求的“待处理”状态。由于API使用请求通知已发送给API管理员，它将等待批准。

一旦API管理员批准：

  • 状态更改为“已批准”。
  • 发放一个可用于API调用的API URL。
  • 您可以使用Swagger测试API。
  • 您可以取消请求或删除“已批准”的API。
危险

如果您删除一个API，发放的API URL将变得无效。

API测试 - Swagger UI​

API文档是基于Swagger提供的，API调用测试通过Swagger > 尝试一下 > 执行进行。

按照以下步骤测试API：

  • 从API KEY屏幕复制您的API KEY。
  • 在Swagger UI中，点击“授权”并输入API KEY。
  • 选择API方法和路径。
  • 点击“尝试一下 > 执行”。
危险

调用API时必须应用API KEY。否则，API调用将因身份验证失败而失败。

我的应用 - 成员管理​

此功能是将成员添加到应用程序并授予添加成员应用程序管理员权限。最初创建应用程序的用户默认获得应用程序管理员权限。

请按照以下步骤操作：

  • 转到“成员管理”菜单。
  • 原始创建者会自动获得应用程序管理员权限。
  • 点击“添加”以添加成员。
危险

只有在 APIM 开发者门户上注册的成员才能被添加。请指导将要作为成员添加的用户先在 APIM 开发者门户上注册。

在“添加成员”弹出窗口中，您可以按照以下步骤操作：

  • 选择一个或多个要添加的用户。
  • 点击“确认”以完成该过程。
危险

请确保检查您要添加的成员的用户 ID，以避免添加错误的用户。

完成添加成员后，您可以在屏幕上看到以下组件：

  • 您可以查看已添加的成员。
  • 您可以授予已添加成员“应用程序管理员”权限。
  • 您还可以将已添加的成员再次排除在“成员”之外。
危险

应用程序管理员权限包括：

  • 修改应用程序名称/图标
  • 删除应用程序
  • 重新发放 API 密钥
  • 请求或取消 API 访问
  • 管理成员和管理员角色

我的应用程序 - IP/引用者白名单​

仅允许来自有限来源的 IP/引用者白名单的 API 调用，其他调用将被阻止。

按照以下步骤将 IP/引用者列入白名单：

  • 转到“IP/引用者白名单”菜单。
  • 点击“添加”以插入条目。
  • 输入 IPv4 CIDR 格式（例如，192.168.0.0/24）。
  • 添加条目的描述。
  • 勾选“活动”以启用规则。务必保存更改。
  • 保存 IPv4 CIDR 条目。只有标记为“活动”的项目将被应用。
  • 根据需要删除条目。删除后保存。