hiddeco/transip

The better TransIP API client.

TransIP

This library is an Object Oriented wrapper for the TransIP SOAP API (v5.6), which aims to provide a better and more structured client than the official TransIP API package, including extensive documentation., _(*1)

, _(*2)

Installation

To use this library without running in to trouble you will need PHP 5.6+ or HHVM 3.6+ and Composer., _(*3)

1. Get the latest version of TransIP by adding the following line to your composer.json file "hiddeco/transip": "5.7.*", _(*4)

2. Run composer update or composer install, _(*5)

Features

• All TransIP services and methods available through one Client
• Follows PSR-4 conventions and PSR-2 coding standards
• Extensively documented

Usage

Basics

Using the Client

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

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

Setting the permission mode and endpoint

Although the permission mode and endpoint are configured by default as readonly and api.transip.nl, it is possible to change them according to your wishes., _(*6)

Note: accepted permission modes are readonly and readwrite. Invalid permission mode will throw an \InvalidArgumentException., _(*7)

$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();
}

Catching \SoapFault

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

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

API documentation

For a full documentation on the available methods foreach API and how to use them take a look at the extensive docs., _(*8)

Contributors

• Hidde Beydals (@hiddeco)
• Peter Steenbergen (@petericebear)

License

TransIP is licensed under The MIT License (MIT)., _(*9)