运用详尽、免费又安全的 API 管理您的 Gandi 产品

Gandi 的 REST API 能简化您的产品管理，请参阅详细的线上文件，了解如何批次操作以及自动执行产品与服务。

了解 Gandi 的 API 文件

自动管理网域名称、DNS、网页代管主机、电子信箱以及 SSL 凭证

透过 API 提供的权限系统，恢复您的个人 API 金钥，并且让您的合作伙伴在专属的角色范围内工作，如此一来，能保障您的团队合作与安全

探索 REST API 的所有功能

简单好用的 API 使用范例

透过您的域名存取

透过您的域名直接在家里存取您的自我代管伺服器

Thanks to our API, you can automatically update the IP address of your router so that the server you host at home will always be available through your domain name.

您可以透过域名 (例如：myserver.example.net) 连接家里的个人服务，例如 RasberryPI、警报系统与智能家庭系统等。

# 用新的 IP 位址更新 DNS 纪录 
 
$ curl --request PUT 
 --url https://api.gandi.net/api/v5/domains/example.net/records/mybox/A \ 
 --header "authorization: Apikey ${API_KEY}" \ 
 --header 'content-type: application/json' \ 
 --data "{ \"rrset_ttl\": 300, \"rrset_values\": [\"1.2.3.4\"] }"

监控域名快来临的到期日

监控域名快来临的到期日

Gandi 会在域名到期日前 60 天寄送电子邮件提醒您。

但是，您可以自订通知，以便加入工作流程，将通知发送到其他团队的协作环境，甚至是将通知发送至您的智慧型手机，以免到期通知信被当作垃圾邮件。

您永远不会因为到期通知信被当作垃圾邮件而忘记续约域名，或是您不想担心这一点的话，您也可以透过 API 启用自动续约功能。

# 每天列出您所有域名的到期日 
 
# 1. 列出您所有的域名 
$ curl --request GET 
 --url https://api.gandi.net/v5/domain/domains 
 --header "authorization: Apikey ${API_KEY}" | jq -r .[].fqdn 
 
# 2. 取得特定域名的到期日 
$ curl --request GET 
 --url https://api.gandi.net/v5/domain/domains/example.net 
 --header "authorization: Apikey ${API_KEY}" | jq -r .dates.registry_ends_at

个人化 DNS 区域档修改通知

个人化 DNS 区域档修改通知

在有敏感域名的专业环境下，自动监控修改区域档是有需要的。

您可以：

  • 从您自己的工具监测变化，以便轻松地将变化与其他事件连结起来
  • 当有修改 DNS 区域档时，自动警示其他团队 (例如：安全团队、沟通团队)，以便他们可以在新的伺服器进行验证。
  • 侦测可能的错误 (例如：删除太多行内容)
# 1. 定期取得 DNS 区域档内容 
 
$ curl --request GET 
 --url https://api.gandi.net/api/v5/domains/example.net/records 
 --header 'accept: text/plain' 
 --header "authorization: Apikey ${API_KEY}" > ma.zone 
 
# 2. 比较不同时候的区域档纪录，查看在指定期间内是否有变更  
 
# 3. 收到已经变更的通知

自动部署您的网站

自动部署您的网站

公开 API 让您可以部署虚拟主机以及自动产生 SSL/TLS 凭证，您也可以整合您自己或客户的网站部署至您的自动化流程中。

# List your Web Hosting instances
 
curl -X GET \
  https://api.gandi.net/v5/simplehosting/instances \
  -H 'authorization: Apikey YOUR-API-KEY'
 
# Create a Wordpress website on a web Hosting instance
 
curl -X POST \
  https://api.gandi.net/v5/simplehosting/instances/<;instance_id>/vhosts \
  -H 'authorization: Apikey YOUR-API-KEY' \
  -H 'content-type: application/json' \
  -d '{"fqdn":"your.fqdn.tld", \
       "linked_dns_zone":{"allow_alteration":"True"}, \
       "application":{"name":"wordpress"}}'

Gandi 的经销商：直接整合您的工具与 Gandi 的 API

  • 您负责管理客户的产品吗？

    快速执行域名使用周期的所有必要操作：注册、续约、移转、建立联络人、管理伺服器与 DNS 区域档...

  • 您的客户是有自主性的吗？

    Gandi 的 API 能完整且透明地整合 Gandi 的服务与您的设计和平台，提升您的产品目录，以提供客户您品牌完整的生态系统，并且保持您客户的忠实度。

  • Gandi 白色标签介面的优点

    Our white label tool allows your customers to easily manage their DNS zones and web forwarding via personalized, secure, and easy-to-use interface. Contact our Corporate Services team for more information.

使用 API 轻松管理产品与服务的范例

透过 Gandi 的 API 管理您的域名标签

透过 Gandi 的 API 管理您的域名标签

您可以建立、修改、新增或删除域名标签以方便管理域名；还是您想辨识您为了防止他人盗用您商标，而注册的域名呢？那么请选择“防护性注册”标签。

$ curl --request POST 
 --url https://api.gandi.net/v5/domain/domains/{domain}/tags 
 --header "authorization: Apikey XXXXX" 
 --header 'content-type: application/json' 
 --data "{\"tag\": \"defensive registration\"}"

使用指令重新寄送存取确认信

使用指令重新寄送存取确认电子邮件

如果您的客户没有收到、没有看到或没有验证您寄出的存取确认电子邮件，您只需使用一个指令，便能重新发送存取确认信。

$ curl --request PATCH 
 --url https://api.gandi.net/v5/domain/domains/DOMAIN/reachability 
 --header "authorization: Apikey XXXXX" 
 --header 'content-type: application/json' 
 --data '{"action":"resend"}'

Gandi 云平台 (OpenStack) API：迈向基础架构程式码

维持您一贯的方法，使用自己的工具来设置 Gandi 云平台 (OpenStack) 伺服器

对您的日常需求来说，使用 OpenStack 设置与传输伺服器是非常实用的。

  • 每台伺服器与 Gandi 云端资源都可以使用公开 OpenStack API 部署与试运行，您可以继续用与您的私有云端基础架构相同的方式使用公开 OpenStack API。
  • 您也可以自由地使用与其他云端供应商一样的部署及基础架构控制工具，例如 Terraform、Ansible、Cloudinit 或 Puppet 等。
  • Gandi 云平台 (OpenStack) 公开 API 让您在基础架构程式码 (IaC) 的模式下，使用您常用的伺服器管理工具来管理您的伺服器与基础架构。

借助 Terraform 与 Cloudinit，自动部署 Jitsi 视讯会议应用程式

借助 Terraform 与 Cloudinit，自动部署 Jitsi 视讯会议应用程式

借助 Terraform 与 Cloudinit，只需 5 分钟，您便能在Gandi 云平台 (OpenStack) 伺服器上安装好视讯会议工具：

  1. 透过 Terraform 自动部署伺服器
  2. 透过 Terraform 产生 SSL 凭证与修改 DNS 区域档
  3. 透过 Cloudinit 自动下载与安装 Jitsi 至伺服器上
# 从 Terraform 的 main.tf 组态档中提取 
 
# 建立 Gandi 云平台 (OpenStack) V-R2 伺服器 
resource "openstack_compute_instance_v2" "jitsi" { 
 name = "jitsi" 
 key_pair = openstack_compute_keypair_v2.jitsi-keypair.name 
 flavor_name = "V-R2" 
 security_groups = ["default"] 
 power_state = "active" 
 network { 
 name = "public" 
 } 
 user_data = "${data.template_file.user_data.rendered}" 
 block_device { 
 uuid = "47edd0a0-23ce-4ce5-9168-36de68990d1b" 
 source_type = "image" 
 volume_size = 25 
 boot_index = 0 
 destination_type = "volume" 
 delete_on_termination = true 
 }

Gandi 云平台 (OpenStack) 伺服器可靠又新颖，可以承载您所有的应用程式

了解 Gandi 云平台 (OpenStack) 伺服器

使用 Gandi API 的理由

  • 可信赖的测试环境

    多亏 Gandi 的 v5 沙盒 (sandbox)，才能安全地测试许多 API 操作。

  • 全天候不间断的服务

    Gandi 的客户服务团队精通 6 种语言，分布于 3 大洲，永远在任何您需要的时候提供您协助。

  • 重视顾客的体验

    您的回馈意见对 Gandi 而言十分珍贵，也是促进我们改善产品的动力。Gandi 的 API 使用起来如何呢？请写下您的宝贵意见吧！

常见问题 FAQ

API (application programming interface，又称应用程式介面) 是一套规则，让软体可以轻松地双向沟通并交换数据。

使用 API 可以节省时间，因为对于数据团队而言，已经不再需要为了任何的程式或服务开发自己的应用程式，只需使用相关的 API，因此 API 现在于各种线上生意而言都是不可或缺的。

举例来说，使用 Gandi API，您可以透过与 Gandi 伺服器自动交换数据来实现讯息处理的自动化，从而实现您的网域名称、网页代管，或是电子信箱帐号的自动化管理。

Gandi API 是 RESTful API，使用 HTTPS 协议与 JSON，目前为止，上述两种是最广泛使用的 API 标准。

想了解所有关于 API 功能与执行 API 的文件，请前往 https://api.gandi.net/docs/ 查阅。

Gandi API 简化您产品的管理程序，让您可以很轻松地建立自订的应用程式，执行与您的 Gandi 服务之相关操作。
API 的目的是自动化所有产品与服务的大量潜在操作。

具体来说，API 是您执行简单且重复性高 (或大量的) 之任务的好伙伴，因为这些任务很难使用经典的网路介面手动完成。

寻求协助

新闻与优惠

查看全部

Subscribe to the Gandi API Newsletter

A dedicated email to know about important updates related to the public API. Stay informed about API enhancements and features updates.

无效的注册

Confirmation email sent

Please check your mailbox in order to confirm your subscription.

线上客服

接受 cookies 才能使用聊天工具

接受 cookies 才能正常运作聊天工具，您可以至我们的隐私与 cookie 使用政策中看到 cookie 的使用细节。

请接受以继续或是 填写客服表单来拒绝。

使用表格