搬瓦工 API 教程:获取 API KEY/调用 API 方法/PHP 示例代码

搬瓦工 KiwiVM 控制面板提供 API 接口,可以通过自己写代码来调用搬瓦工 API。本文分享一下搬瓦工 API 教程,包括怎么获取搬瓦工 API KEY(API 密钥),怎么重置 API KEY,以及获取了 API KEY 之后怎么通过代码进行调用,包括使用 PHP 代码,或者是直接用 wget 和 curl 等工具进行调用。其实调用方法还是很简单的,就是发送个请求,然后返回个结果而已。

一、搬瓦工获取 API KEY 方法

首先是获取 API KEY,我们可以直接在 KiwiVM 控制面板左侧菜单的 API 选项里进行获取,如图所示。

也可以直接批量导出所有 VPS 的 API KEY,参考《搬瓦工官网后台 [Export all services with private API keys] 功能解读》。

二、搬瓦工调用 API 方法

有了 API KEY 和 VEID 之后,就可以进行调用了。

Whether you want to automatically create nightly snapshots, query status of your VPS, or develop a complete replacement for the KiwiVM panel, this page is for you.

To export a csv-formatted list of API keys of all instances under your account, please use our billing portal’s CSV export feature.

All parameters can be passed either via GET or POST methods.

  • 无论您是想自动创建夜间快照、查询 VPS 状态,还是开发 KiwiVM 面板的完整替代品,此页面都适合您。
  • 要导出您账户下所有实例的 API 密钥的 csv 格式列表,请使用我们的账单门户的 CSV 导出功能(搬瓦工官网后台 [Export all services with private API keys] 功能解读)。
  • 所有参数都可以通过 GET 或 POST 方法传递。

简而言之,只需要向下面地址发送 GET 或者 POST 请求即可:

https://api.64clouds.com/v1/getServiceInfo?veid=YOUR_VEID_HERE&api_key=YOUR_API_KEY_HERE

上面地址中的一些信息需要替换:

  • getServiceInfo:可以替换成其他的 API 功能,所有可用接口请参考搬瓦工 KiwiVM 控制面板的 API 页面
  • YOUR_VEID_HERE:替换成你的 VEID
  • YOUR_API_KEY_HERE:替换成你的 API KEY

每个 API 调用都要求您提供 VEID (VPS ID) 和 API 密钥的有效组合,如示例中所示。

每个 API 调用总是返回错误变量。 如果错误不为零,请检查“message”变量以获取有关错误的更多详细信息。

相关教程:《搬瓦工高级教程:使用Python调用KiwiVM面板API》。

三、PHP 示例代码和返回结果

下面给出一个 PHP 示例代码,更为直观一些。

PHP 代码获取 VPS 信息:

$request = "https://api.64clouds.com/v1/getServiceInfo?veid=YOUR_VEID_HERE&api_key=YOUR_API_KEY_HERE";
$serviceInfo = json_decode (file_get_contents ($request));
print_r ($serviceInfo);

返回结果如下:

/* ------------------------------- [ output ] -------------------------------
stdClass Object
(
    [hostname] => my.server.com
    [node_ip] => 10.20.30.40
    [node_alias] => Node32
    [node_location] => US, Florida
    [plan] => micro128
    [plan_monthly_data] => 322122547200
    [plan_disk] => 4294967296
    [plan_ram] => 155189248
    [plan_swap] => 37748736
    [os] => centos-6-x86_64
    [email] => customer@example.com
    [data_counter] => 569810827
    [data_next_reset] => 1430193600
    [ip_addresses] => Array
        (
            [0] => 11.22.33.44
            [1] => 11.22.33.45
        )

    [rdns_api_available] => 1
    [ptr] => stdClass Object
        (
            [11.22.33.44] => ns1.my.server.com
            [11.22.33.45] => ns2.my.server.com
        )

    [error] => 0
)
*/

这个返回结果可能不是最全的,最新返回结果以实际返回为准,应该会包含更多的信息。

四、使用 wget 和 curl 调用 API

其实直接使用 wget 或者 curl 命令也可以调用 API,下面做个分享。

使用 wget 调用 API:

wget -qO- "https://api.64clouds.com/v1/restart?veid=YOUR_VEID_HERE&api_key=YOUR_API_KEY_HERE"

使用 curl 调用 API:

//You may want to use curl instead as it allows passing all variables in a POST request

$requestData = array ("veid" => YOUR_VEID_HERE, "api_key" => "YOUR_API_KEY_HERE");
$request = "restart";
$ch = curl_init(); 
curl_setopt($ch, CURLOPT_URL, "https://api.64clouds.com/v1/$request"); 
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0); // curl running on Windows has issues with SSL - 
                                             // see https://kb.ucla.edu/articles/how-do-i-use-curl-in-php-on-windows
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $requestData);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); 
$jsonData = curl_exec($ch); 
if (curl_error($ch)) die("Connection Error: ".curl_errno($ch)." - ".curl_error($ch));
curl_close($ch);
print_r (json_decode ($jsonData));

curl 允许在 POST 请求中传递所有变量,所以可能需要更多设置的话就会用到 curl,不然的话我们使用 wget 即可。

以上就是搬瓦工 API 调用的一些教程,总体还是不难。

五、搬瓦工新手教程和优惠套餐

搬瓦工推荐方案

搬瓦工实时库存:https://stock.bwg.net

温馨提醒 如果您有选择困难症,直接选中间的 CN2 GIA-E方案,季付 $49.99,多达 12 个机房任意切换
方案内存CPU硬盘流量/月带宽机房价格购买
CN2
(最便宜)
1GB1核20GB1TB1GbpsDC3 CN2
DC8 ZNET
$49.99/年购买
CN22GB1核40GB2TB1Gbps$52.99/半年
$99.99/年
购买
CN2 GIA-E
(最推荐)
1GB2核20GB1TB2.5GbpsDC6 CN2 GIA-E
DC9 CN2 GIA
日本软银 JPOS_1
联通荷兰 EUNL_9
$49.99/季度
$169.99/年
购买
CN2 GIA-E2GB3核40GB2TB2.5Gbps$89.99/季度
$299.99/年
购买
HK2GB2核40GB0.5TB1Gbps香港 CN2 GIA$89.99/月
$899.99/年
购买
HK4GB4核80GB1TB1Gbps$155.99/月
$1559.99/年
购买

选择建议:

  • 入门:洛杉矶 CN2 套餐,目前最便宜,可选 CN2 GT 机房,入门之选。
  • 推荐:洛杉矶 CN2 GIA-E 套餐,速度超快,可选机房多(DC6、DC9、日本软银、荷兰联通等),性价比最高。
  • 高端:香港 CN2 GIA 套餐,价格较高,但是无可挑剔。

搬瓦工新手教程

  1. 搬瓦工新手入门:《搬瓦工新手入门完全指南:方案推荐、机房选择、优惠码和购买教程(推荐阅读)
  2. 搬瓦工购买教程:《2021 年最新搬瓦工购买教程和支付宝支付教程
  3. 搬瓦工优惠码:BWH3HYATVBJW
  4. 搬瓦工补货通知:《欢迎订阅搬瓦工补货通知(补货提醒)/ 加入搬瓦工交流群
  5. 搬瓦工方案推荐:《搬瓦工高性价比 VPS 推荐:目前哪款方案最值得买?

未经允许不得转载:Bandwagonhost中文网 » 搬瓦工 API 教程:获取 API KEY/调用 API 方法/PHP 示例代码