hiddeco/transip

更好的TransIP API客户端。

v5.7 2018-06-28 19:28 UTC

This package is not auto-updated.

Last update: 2024-09-14 17:26:40 UTC


README

这个库是对TransIP SOAP API (v5.6)的面向对象封装,旨在提供比官方TransIP API包更好、更结构化的客户端,包括详尽的文档。

TransIP SOAP client

安装

为了无故障地使用此库,您需要PHP 5.6+或HHVM 3.6+以及Composer。

  1. 将以下行添加到您的composer.json文件中获取最新版本的TransIP:"hiddeco/transip": "5.7.*"

  2. 运行composer updatecomposer install

特性

  • 通过一个Client即可访问所有TransIP服务和方法
  • 遵循PSR-4约定和PSR-2编码标准
  • 详尽文档

使用说明

基本操作

使用Client

// Composer autoload
require_once 'vendor/autoload.php';

$client = new \TransIP\Client('username', 'privateKey');
$domainNames = $client->api('domain')->getDomainNames();

设置权限模式和端点

尽管权限模式和端点默认配置为readonlyapi.transip.nl,但您可以根据自己的需求更改它们。

注意:接受的权限模式为readonlyreadwrite。无效的权限模式将抛出 \InvalidArgumentException

$client = new \TransIP\Client('username', 'privateKey', 'readwrite', 'api.transip.nl');

// set permission mode on the run
try {
    $client->setMode('readonly');
} catch(\InvalidArgumentException $e) {
    echo $e->getMessage();
}

捕获\SoapFault

$client = new \TransIP\Client('username', 'privateKey');

try {
    $client->api('domain')->getDomainNames();
} catch(\SoapFault $e) {
    $echo $e->getMessage();
}

API文档

有关每个API可用方法和如何使用的完整文档,请参阅详尽的文档

贡献者

许可协议

TransIP遵循MIT许可协议(MIT)