library omneo-php {🖫 168, ⚐ 18, ★ 1}

omneo/omneo-php

PHP library for the Omneo API

Thursday, July 26, 2018
by dangreaves
Repository
4 Watchers
1 Stars
168 Installations

PHP
0 Dependents
0 Suggesters
0 Forks
0 Open issues
18 Versions
87 % Grown

The README.md

, _(*1)

GitHub release , _(*2)

Omneo PHP is a PHP client library for the Omneo API service. It allows developers to easily integrate Omneo with their PHP applications., _(*3)

Read the documentation ⟶, _(*4)

Prerequisites
Quickstart
Contributing

Prerequisites

Before being able to use the package, you will need to get your hands on the following., _(*5)

Omneo domain - This takes the form of example.omneoapp.io and is where your Omneo installation lives. If you login to your dashboard at foo.dashboard.omneo.io, your Omneo domain is foo.omneoapp.io., _(*6)
Omneo token - This is the secure token which identifies you to the API. It can be generated from the Omneo dashboard and is associated with your user account. It is advisable that you create a separate Omneo user specifically for your integration., _(*7)
Shared secret - You only need this if you plan on accepting incoming webhook and target requests from Omneo. If so, you will need to validate that it's actually Omneo sending the request by generating and comparing a signature using the shared secret., _(*8)

Installation

Installation is performed via Composer., _(*9)

composer require omneo/omneo-php

Quickstart

Plain PHP

// Get credentials, you should store these outside of your codebase
$domain = 'foo.omneoapp.io';
$token = '...';

// Instantiate the Omneo client
$omneo = new Omneo\Client($domain, $token);

// Optional, add the shared secret for verifying webhooks and targets
$omneo->setSecret('horsebatterystaple');

// Use the client to communicate with omneo
$profiles = $omneo->profiles()->browse();

Laravel

This package utilises Laravel Package Discovery which means you do not need to register any service providers after installation, just type hint and go!, _(*10)

This package comes batteries-included for usage with Laravel. To begin, install the package using Composer and update the following files., _(*11)

config/services.php

'omneo' => [
    'domain' => env('OMNEO_DOMAIN'),
    'token' => env('OMNEO_TOKEN'),
    'secret' => env('OMNEO_SECRET')
]

.env

OMNEO_DOMAIN=
OMNEO_TOKEN=
OMNEO_SECRET=

Now that you're authentication details are set, you can utilise the Omneo package anywhere in your application that has access to the Service Container., _(*12)

class FooController extends Controller
{    
    public function getProfiles(Omneo\Client $omneo)
    {
        // Using typehints
        $profiles = $omneo->profiles()->browse();

        // Using the app() method
        $profiles = app(Omneo\Client::class)->profiles()->browse();
    }
}

Contributing

To contribute to this package, please open a Pull Request., _(*13)

Testing

Testing is handled by phpunit. Pull requests should include unit tests for the affected logic., _(*14)

phpunit

The Versions

26/07 2018

dev-master

9999999-dev

PHP library for the Omneo API

Sources Download

MIT

The Requires

The Development Requires

26/07 2018

0.3.7

0.3.7.0

PHP library for the Omneo API

Sources Download

MIT

The Requires

The Development Requires

25/07 2018

dev-feature/add_rating

PHP library for the Omneo API

Sources Download

MIT

The Requires

The Development Requires

25/07 2018

dev-feature/batch

PHP library for the Omneo API

Sources Download

MIT

The Requires

The Development Requires

18/06 2018

0.3.6

0.3.6.0

PHP library for the Omneo API

Sources Download

MIT

The Requires

The Development Requires

18/06 2018

dev-feature/transactions

PHP library for the Omneo API

Sources Download

MIT

The Requires

The Development Requires

06/06 2018

0.3.5

0.3.5.0

PHP library for the Omneo API

Sources Download

MIT

The Requires

The Development Requires

31/05 2018

0.3.4

0.3.4.0

PHP library for the Omneo API

Sources Download

MIT

The Requires

The Development Requires

31/05 2018

dev-feature/better-identity-access

PHP library for the Omneo API

Sources Download

MIT

The Requires

The Development Requires

30/05 2018

0.3.3

0.3.3.0

PHP library for the Omneo API

Sources Download

MIT

The Requires

The Development Requires

30/05 2018

dev-feature/redemptions

PHP library for the Omneo API

Sources Download

MIT

The Requires

The Development Requires

29/05 2018

0.3.2

0.3.2.0

PHP library for the Omneo API

Sources Download

MIT

The Requires

The Development Requires

29/05 2018

dev-feature/id-search

PHP library for the Omneo API

Sources Download

MIT

The Requires

The Development Requires

29/05 2018

dev-feature/locations

PHP library for the Omneo API

Sources Download

MIT

The Requires

The Development Requires

25/05 2018

0.3.1

0.3.1.0

PHP library for the Omneo API

Sources Download

MIT

The Requires

The Development Requires

17/05 2018

0.3.0

0.3.0.0

PHP library for the Omneo API

Sources Download

MIT

The Requires

The Development Requires

17/05 2018

0.2.0

0.2.0.0

PHP library for the Omneo API

Sources Download

MIT

The Requires

The Development Requires

01/05 2018

0.1.0

0.1.0.0

PHP library for the Omneo API

Sources Download

MIT