https://github.com/nexylan/gandi-sdk

PHP sdk to communicate with the Gandi API
https://github.com/nexylan/gandi-sdk

Last synced: 3 months ago
JSON representation

PHP sdk to communicate with the Gandi API

• Host: GitHub
• URL: https://github.com/nexylan/gandi-sdk
• Owner: nexylan
• License: mit
• Created: 2017-10-09T12:10:14.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-03-08T10:29:16.000Z (11 months ago)
• Last Synced: 2024-08-11T11:16:58.290Z (6 months ago)
• Language: PHP
• Size: 29.3 KB
• Stars: 2
• Watchers: 6
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Gandi SDK

Gandi API PHP SDK.

[![Latest Stable Version](https://poser.pugx.org/nexylan/gandi-sdk/v/stable)](https://packagist.org/packages/nexylan/gandi-sdk)

[![Latest Unstable Version](https://poser.pugx.org/nexylan/gandi-sdk/v/unstable)](https://packagist.org/packages/nexylan/gandi-sdk)

[![License](https://poser.pugx.org/nexylan/gandi-sdk/license)](https://packagist.org/packages/nexylan/gandi-sdk)

[![Total Downloads](https://poser.pugx.org/nexylan/gandi-sdk/downloads)](https://packagist.org/packages/nexylan/gandi-sdk)

[![Monthly Downloads](https://poser.pugx.org/nexylan/gandi-sdk/d/monthly)](https://packagist.org/packages/nexylan/gandi-sdk)

[![Daily Downloads](https://poser.pugx.org/nexylan/gandi-sdk/d/daily)](https://packagist.org/packages/nexylan/gandi-sdk)

## Documentation

All the installation and usage instructions are located in this README.

Check it for a specific versions:

* [__0.x__](https://github.com/nexylan/gandi-sdk/tree/master)

## Installation

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

``` bash

composer require nexylan/gandi-sdk

```

With Symfony:

Enable the bundle on the `AppKernel` class:

```php

// app/AppKernel.php

public function registerBundles()

{

    $bundles = array(

        // ...

        new Nexy\Gandi\Bridge\Symfony\Bundle\NexyGandiBundle(),

    );

    // ...

    return $bundles

}

```

## Configuration

Configure the bundle to your needs:

```yaml

# parameters.yml

parameters:

    # Change to https://rpc.gandi.net/xmlrpc/ in prod

    gandi_api_url: https://rpc.ote.gandi.net/xmlrpc/

```

```yaml

# config.yml

nexy_gandi:

    api_url: %gandi_api_url%

    api_key: 'yourApiKey'

```

## Usage

Use the predefined methods and/or use Gandi methods directly

```php

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

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

// Results

// [

//     status => [

//         0 => clientTransferProhibited

//     ]

//     zone_id => 42

//     fqdn => mydomain.net

//     // ...

// ]

```