cPanel面板管理API令牌

注意：本教程适用于 82 至最新版本。

一、概述

cPanel面板的管理API令牌功能是一个试验性的功能，允许用户创建、列出、更新和撤销API标记。通过管理API令牌，用户可以为其账户生成具有特定权限的API标记，用于访问和操作cPanel面板提供的API功能，而无需登录到cPanel界面。

API标记可以被用来执行各种操作，如查看和更改账户数据，管理文件和目录，设置DNS记录等。用户可以根据需要为不同的应用程序或第三方服务生成不同权限的API标记，并将其应用于相应的操作中。

使用管理API令牌功能，用户可以更加灵活地管理其账户数据和进行自动化操作。例如，用户可以将API标记分享给合作伙伴或经销商，以便他们能够使用这些标记来检查磁盘使用情况或执行其他操作，而无需直接登录到cPanel面板。

注意：

• API 标记运行 UAPI 功能和 cPanel API 2 功能，而不是 cPanel API 1 功能；
• 使用 API 令牌可从命令行运行 API 函数。

二、创建API标记

要创建 API 标记，请执行以下步骤：

1、单击创建，将出现创建 API 令牌界面。

2、在 API 令牌名称文本框中输入一个唯一的名称。

注意：

• API 令牌名称最多只能包含 50 个字符；
• 只能输入字母（a - z 和 A - Z）、数字（0 - 9）、破折号 ( - ) 和下划线 ( _ )。

3、从 "API 令牌是否过期？"部分选择以下选项之一：

• API 令牌不会过期 - 将创建一个没有过期日期的令牌；
• 指定过期日期 - 可以创建一个在特定日期过期的令牌。默认情况下，令牌从当前日期起一年后过期。选择此选项后，界面将显示 API 令牌过期日期部分。使用日历图标（日历）打开日历，选择所需的过期日期。也可以在日历文本框中输入自定义日期，格式为 YYYY-MM-DD。令牌将在服务器时间 23:59:59 选择的日期到期。

注意：

• 创建后无法编辑 API 令牌到期日期；
• API 令牌过期后，系统不会将其删除。必须手动删除 API 令牌。

4、单击创建，将出现一个新界面。

要复制 API 令牌，请单击 "复制"。把这个令牌想象成密码。每次使用时都必须输入此令牌。

注意：离开界面后，就无法访问令牌了。如果忘记或放错了令牌，必须撤销令牌，然后创建一个新的令牌。

5、单击“Yes, I Saved My Token”。

• 要创建新的令牌，请选择 单击“Yes, I Saved My Token "复选框；
• 要返回 "列出 API 令牌 "界面，请取消选择 "Yes, I Saved My Token "复选框。

三、API标记表

该表显示所有 API 标记，可以执行以下功能：

1、要在每页显示更多 API 令牌，请单击齿轮图标，然后选择一个数字。

2、要撤销多个令牌：

• 选择要撤销的每个令牌的复选框，选择表格顶部的复选框以选择每个令牌；
• 单击吊销，将出现一条确认信息；

• 单击撤销选定的 API 令牌。

API 令牌表包含以下信息：

1、Token Name - API 令牌的名称。

2、创建于 - 创建 API 令牌的日期和时间。

3、过期 - 如果 API 令牌过期，则指令牌过期的日期和时间：

• 当 API 令牌即将过期时，界面会以黄色显示其条目行，它还会显示一个通知图标（通知）；
• 当 API 令牌即将过期时，界面会以红色显示过期的 API 令牌条目行。它还会显示一个通知图标 (通知)。

注意：当 API 标记过期时，系统不会删除它们，必须手动删除过期的 API 标记。

4、管理 - 单击 "管理 "打开一个新界面，可以在此执行以下操作：

• 重命名令牌 - 为令牌指定一个新名称；
• 撤销令牌 - 删除令牌，阻止其访问服务器或任何 API 功能。

四、管理API令牌

要管理 API 令牌，请在 API 令牌表中找到令牌，然后单击 "管理"；

管理 API 令牌界面就会出现。

五、重命名令牌

要为令牌指定新名称，请在 "新 API 令牌名称 "文本框中输入新名称，然后点击更新。

六、撤销令牌

注意：如果撤销 API 令牌，用户将无法使用该令牌运行任何脚本或 API 功能。

要撤销 API 令牌，请执行以下操作：

1、单击撤销，将出现一条确认信息。

2、单击“Yes, Revoke The Token”。

注意：要在命令行上删除 API 令牌，请使用 UAPI Tokens::revoke 函数。