<所有主题

API基础

SPanel使用REST API,该API依赖于来自API端点的POST相关请求和JSON格式的响应。
所有API请求都在位于SPanel目录内的API端点上执行。

https://IP_or_HOSTNAME/spanel/api.php

警告
API终结点取决于品牌url设置,因此如果虚拟机的所有者从管理界面启用该功能,则文件夹的名称可能会更改为“hostpanel”或“spanel”(默认)。

身份验证

使用从SPanel管理界面生成的API令牌执行身份验证。API令牌与请求的其余部分一起提供在“令牌”变量中。令牌可以是基于管理员或客户端的令牌,具体取决于它们的生成方式。

基于管理员的令牌可以访问SPanel管理界面中的可用功能。对使用管理令牌的API的请求不应提供“accountuser”字段。

基于客户端的令牌使用客户端用户名生成,并且仅限于对生成用户名执行SPanel客户端界面操作。在向SPanel API进行身份验证时,在“accountuser”字段中提供帐户用户名。

现场类型要求的说明
代币一串是的从SPanel管理界面生成的身份验证令牌
帐户使用者一串帐户用户(如果令牌是用户特定的)

参数

请求调用需要1个附加参数“action”。它取决于令牌/用户组合的类型,对于管理员和客户端调用是不同的。根据执行的函数,可能需要其他参数。更多信息可以在每个函数的文章中找到。

现场类型要求的说明
行动一串是的正在执行的类别和功能
帐户使用者一串是/否accountuser参数仅在执行用户功能时是必需的。它包含将执行该功能的SPanel用户帐户名。

例子

$endpointUrl = 'https://123.123.123.123/spanel/api.php';$postData = [  'token' => 'provided_auth_token',  'accountuser' => 'username',  'action' => 'accounts/listaccounts',];$ch = curl_init();curl_setopt( $ch, CURLOPT_URL, $endpointUrl);curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1);curl_setopt( $ch, CURLOPT_POST, true);curl_setopt( $ch, CURLOPT_POSTFIELDS, http_build_query($postData));curl_setopt( $ch, CURLOPT_SSL_VERIFYPEER, false);curl_setopt( $ch, CURLOPT_SSL_VERIFYHOST, false);$jsonOutput = curl_exec( $ch );

输出

成功

上述请求将提供以下json输出:

{“数据”:〔{“域”:“testdomain.com”,“用户”:“测试用户”,“ip”:“123.123.123.123”,“磁盘”:“123”,“索引节点”:“122”,“home目录”:“home”,“numaddons”:“0”,“num子域”:“1”,“Num数据库”:“3”,“电子邮件限制”:“无限制”,“数据库限制”:《无限制》,“安装日期”:“2021年10月1日”,“软件包”:“自定义”}]}

错误

输出错误始终具有标准格式,提供了一系列错误字段,其中包含为相应问题提供的描述性文本。

{“result”:“error”,“message”:〔{“error1”:“error1的描述性错误消息”,“error2”:“error2的描述性错误信息”〕}
目录