README

Introduction

This library allows easy integration of the Constellix V4 API into a Laravel application. It adds a Service Provider and exposes LengthAwarePaginators for resources.

Installation

Include the package through composer:

composer require tiggee/constellix-v4-laravel

The package will be downloaded and auto-discovered by laravel. You can now publish the config file using:

php artisan vendor:publish --provider="Tiggee\ConstellixApiLaravel\ServiceProvider"

The next steps will be to configure the API client and use it.

Without Auto-Discovery

If you are not using auto-discovery for packages, you can add the service provider to the providers array in config/app.php:

Tiggee\ConstellixApiLaravel\ServiceProvider::class,

Configuration

The configuration file that is published is configured to use environment variables for the configuration:

CONSTELLIX_API_SECRET=Your API Secret Key
CONSTELLIX_API_KEY=Your API Key

You can also specify CONSTELLIX_API_ENDPOINT if you want to override the endpoint used for the API, but this should be left undefined by default.

Usage

The API's contract is registered as an interface, so can be typehinted in constructors.

Type Hinting

<?php
namespace App\Http\Controllers;

use Constellix\Client\Interfaces\ConstellixApiClient;

class HomeController extends Controller {

    public function index(ConstellixApiClient $api): void
    {
        $domain = $api->domains->get(1234);
    }
}

Service Container Resolution

<?php
use Constellix\Client\Interfaces\ConstellixApiClient;
$api = resolve(ConstellixApiClient::class);
$domain = $api->domains->get(1234);

API Usage

For usage of the API client, please read the documentation supplied for the client on GitHub.

Support

This is an open-source project and if you have any problems with it, please raise issues in this project and we will look at them. If you have any fixes or improvements, please open a pull request and we'll be happy to review it and include it.

Development

We use PHPStan with a level of 8 and follow PSR-12 coding standards, enforced with PHP Code Sniffer. Testing is using PHP Unit.

The scripts have been added to composer.json.

License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

tiggee / constellix-v4-client-laravel

Maintainers

Details