nexylan/gandi-sdk

PHP sdk to communicate with the Gandi API

v0.4.0 2019-06-06 12:44 UTC

This package is auto-updated.

Last update: 2022-11-06 20:04:09 UTC


README

Gandi API PHP SDK.

Latest Stable Version Latest Unstable Version License

Total Downloads Monthly Downloads Daily Downloads

Documentation

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

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
//     // ...
// ]