Megaport API 概览

Megaport 提供公共 API，用于访问通过 Megaport Portal 提供的所有服务。您可以使用该 API 将 Megaport 的开通与配置实现自动化，从而节省时间和精力。

Megaport API 基于 REST。该 API 具有可预测的 URL，接受表单编码的请求体，返回 JSON 编码的响应，并使用标准 HTTP 状态码。

本节中的主题将引导您完成执行常见任务所需的 API 调用，例如登录、创建一个 Port，以及从该 Port 到云服务商创建一个 VXC。

除此之外，您可以在以下地址查看完整的 API 参考： https://dev.megaport.com。

注意

我们会不时在发布新功能时更新、变更版本并弃用 API。我们建议您及时了解这些变更，并相应规划任何 API 集成的更新。有关更多信息，请参阅 API 弃用通知与常见问题 (FAQ)。

环境

API 提供两个服务器环境：

生产环境 – https://api.megaport.com
您需对在此系统中订购的任何服务及相关费用负责。

通过 https://api.megaport.com 进行的 API 更改会反映在 Megaport Portal 中。
预生产（测试）环境 – https://api-staging.megaport.com
您可以在此预生产环境中测试任何操作，API 调用和响应与生产系统一致，但不会部署服务，也不会因任何操作而产生费用。

您的预生产门户账户会显示创建的预生产服务；但是，这些服务会每 24 小时重置一次。

您可以使用生产环境的凭据登录预生产环境并订购或编辑服务。（新的用户账户需要 24 小时后才可在预生产环境中使用。）

通过 https://api-staging.megaport.com 进行的 API 更改会反映在 Staging Portal。

注意

这些 API 主题中的请求使用 {baseUrl} 变量。您可以将其替换为预生产 URL (https://api-staging.megaport.com) 或生产 URL (https://api.megaport.com)，具体取决于您是要测试配置还是在生产部署中工作。如果您使用 Postman collection （在下一节中介绍），可以在集合中定义 environment variables，以在 API 请求中自动填充 baseUrl 值，并轻松在预生产和生产环境之间切换。

API 和 Postman 入门

编写并部署调用 Megaport API 的客户端代码时，您可以使用任意您偏好的语言，从 Java 到 Python 均可。

若要按步骤完成这些 API 主题中的教程，建议使用已导入 Megaport Collection 的 Postman 客户端。

Postman 是一款简洁而强大的 HTTP 客户端，可帮助您构建、测试和修改 API。您可以用它与任何 API 的任意功能进行交互。Postman Collections 只是按文件夹组织的一组预构建请求，且可以轻松导出并与他人共享。

在 Postman 中开始使用 Megaport Collection 之前，您需要一个 Megaport 账户，并需要安装 Postman。

在 Postman 中设置 Megaport Collection

从 dev.megaport.com 下载 Postman API Collection。
单击链接页面右上角的 Run In Postman (在 Postman 中运行) 按钮。