transip/transip-api-php

TransIP Rest API 库

6.53.1 2024-09-18 08:53 UTC

README

PHP RestAPI 库

这个库是与 TransIP RestAPI 通信的完整实现。它涵盖了TransIP RestAPI 文档中所有可用的资源调用,并允许您的项目轻松连接到 TransIP RestAPI。使用此库,您可以从 TransIP 账户订购、更新和删除产品。

Latest Stable Version Total Downloads License

已弃用的 SOAP API 库(v5.x)

从版本 6.0 开始,此库不再与 TransIP SOAP API 兼容,因为该库现在围绕 REST 组织。SOAP API 库版本 5.* 已弃用,并将不再接收未来的更新。

要求

PHP RestAPI 库需要以下内容才能正常工作

  • PHP 7.2.0 或更高版本。
  • json(php 扩展)
  • openssl(php 扩展)

Composer

您可以使用 Composer 安装 RestAPI 库。运行以下命令

composer require transip/transip-api-php

要在您的代码中使用库,请使用 Composer 的自动加载器

require_once('vendor/autoload.php');

入门

如何进行认证

use Transip\Api\Library\TransipAPI;

require_once(__DIR__ . '/vendor/autoload.php');

// Your login name on the TransIP website.
$login = '';

// If the generated token should only be usable by whitelisted IP addresses in your Controlpanel
$generateWhitelistOnlyTokens = true;

// One of your private keys; these can be requested via your Controlpanel
$privateKey = '';

$api = new TransipAPI(
    $login,
    $privateKey,
    $generateWhitelistOnlyTokens
);

// Create a test connection to the api
$response = $api->test()->test();

if ($response === true) {
    echo 'API connection successful!';
}

获取所有域名

$allDomains = $api->domains()->getAll();

更新单个 DNS 记录

$homeIpAddress = '37.97.254.1'; 

$dnsEntry = new \Transip\Api\Library\Entity\Domain\DnsEntry();
$dnsEntry->setName('homeip'); // subdomain
$dnsEntry->setExpire(300);
$dnsEntry->setType('A');
$dnsEntry->setContent($homeIpAddress);

$api->domainDns()->updateEntry('example.com', $dnsEntry);

有关基本示例,请参阅 examples/ 目录。您还可以查看我们命令行应用程序中实现的所有资源调用。