transip/transip-api-php

TransIP Rest API Library

6.53.1 2024-09-18 08:53 UTC

Requires

• php: ^7.2.0|^8.0
• ext-json: *
• ext-openssl: *
• guzzlehttp/guzzle: ^6.5|^7.4
• php-http/client-common: ^2.5
• php-http/discovery: ^1.14
• psr/cache: ^1.0.1|^3.0
• symfony/cache: ^3.4|^4.4|^5.0|^6.0|^7.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.0
• nyholm/psr7: ^1.5
• php-http/client-implementation: ^1.0
• php-http/guzzle7-adapter: ^1.0
• php-parallel-lint/php-parallel-lint: ^1.2
• phpstan/phpstan: ^1.5
• phpunit/phpunit: ^9.5

Suggests

• php-http/guzzle7-adapter: Guzzle is a PHP HTTP client that makes it easy to send HTTP requests and trivial to integrate with web services.

Apache-2.0

• TransIP

README

RestAPI library for PHP

This library is a complete implementation for communicating with the TransIP RestAPI. It covers all resource calls available in the TransIP RestAPI Docs and it allows your project(s) to connect to the TransIP RestAPI easily. Using this library you can order, update and remove products from your TransIP account.

Deprecated SOAP API library (v5.x)

As of version 6.0 this library is no longer compatible with TransIP SOAP API because the library is now organized around REST. The SOAP API library versions 5.* are now deprecated and will no longer receive future updates.

Requirements

The PHP RestAPI library requires the following in order to work properly:

• PHP 7.2.0 or later.
• json (php extension)
• openssl (php extension)

Composer

You can install the RestAPI library using Composer. Run the following command:

composer require transip/transip-api-php

To use the library in your code, use Composer's autoloader:

require_once('vendor/autoload.php');

Getting started

How to get authenticated:

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!';
}

Get all domains

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

Update a single DNS record

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

For basic examples, please take a look into the examples/ directory. You can also see all resource calls implemented in our command line application