开发者指南：使用 API 自动化您的工作流

独角鲸云 V2.0 不仅仅提供美观的 Web 界面，我们还为开发者准备了完整的开放接口（API）。通过这些接口，您可以编写脚本来自动购买、管理和监控您的虚拟机（VM）。

1. 访问在线接口文档

我们使用 OpenAPI 3.0 标准编写了详细的接口文档。您可以通过以下链接直接在线查看、搜索和调试：

👉 在线接口文档 (Swagger UI)

在该文档中，您可以找到：

• 每个接口的详细参数说明。
• 响应数据的结构定义。
• 在线测试功能（Try it out）。

2. 获取 API 密钥 (API Key)

在调用接口之前，您需要先生成一个身份凭证：

1. 登录 独角鲸云 V2.0 控制面板。
2. 进入 [账号设置] 页面。
3. 滚动到 API 密钥 板块。
4. 点击 [生成密钥] 按钮。
5. 复制生成的 UUID 格式字符串，请妥善保管，不要泄露。

3. 如何进行身份认证

独角鲸云 V2.0 API 采用统一的 Bearer 认证方式。您只需要在 HTTP 请求头中添加 Authorization 字段即可。

格式如下： Authorization: Bearer <您的_API_KEY>

提示：系统会自动检测 Bearer 后面跟随的是传统的 JWT Token 还是 API Key。对于程序化调用，我们强烈建议使用 API Key。

4. 调用示例 (cURL)

以下是几个常用的 API 调用示例：

获取个人账户资料

curl -H "Authorization: Bearer YOUR_API_KEY" \
     https://api.fuckip.me/api/v1/user/me

列出我名下的所有虚拟机

curl -H "Authorization: Bearer YOUR_API_KEY" \
     https://api.fuckip.me/api/v1/vms

启动一台虚拟机

curl -X POST \
     -H "Authorization: Bearer YOUR_API_KEY" \
     https://api.fuckip.me/api/v1/vms/{vm_id}/start

5. 错误处理

API 返回的数据遵循统一的信封格式：

{
  "code": 0,
  "msg": "ok",
  "data": { ... }
}

• code 为 0 表示操作成功。
• 如果 code 非零，msg 字段将包含具体的错误信息。

总结

开放接口为 独角鲸云 V2.0 带来了无限的扩展性。无论您是想集成到自己的管理系统，还是想编写自动续费、自动扩容的脚本，API 都能满足您的需求。

如果您在使用过程中有任何疑问，欢迎通过工单系统与我们联系。