nexylan/gandi-sdk

PHP sdk to communicate with the Gandi API

v0.7.0 2024-03-08 10:25 UTC

Requires

• php: ^7.2 || ^8.0
• lstrojny/fxmlrpc: ^0.22

Requires (Dev)

• matthiasnoback/symfony-config-test: ^4.3
• symfony/dependency-injection: ^4.4
• symfony/http-kernel: ^4.4

Suggests

• php-http/httplug-bundle: For Symfony integration as a bundle with lstrojny/fxmlrpc

MIT

• Jérôme Pogeant

• symfony
• api
• Gandi

README

Gandi API PHP SDK.

Documentation

All the installation and usage instructions are located in this README. Check it for a specific versions:

• 0.x

Installation

First of all, you need to require this library through Composer:

composer require nexylan/gandi-sdk

With Symfony:

Enable the bundle on the AppKernel class:

// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new Nexy\Gandi\Bridge\Symfony\Bundle\NexyGandiBundle(),
    );

    // ...

    return $bundles
}

Configuration

Configure the bundle to your needs:

# parameters.yml
parameters:
    # Change to https://rpc.gandi.net/xmlrpc/ in prod
    gandi_api_url: https://rpc.ote.gandi.net/xmlrpc/

# config.yml
nexy_gandi:
    api_url: %gandi_api_url%
    api_key: 'yourApiKey'

Usage

Use the predefined methods and/or use Gandi methods directly

$gandi = new Gandi('api_url', 'api_key');

$result = $gandi->setup()->domain->info('mydomain.net');

// Results
// [
//     status => [
//         0 => clientTransferProhibited
//     ]
//     zone_id => 42
//     fqdn => mydomain.net
//     // ...
// ]