coolcodemy/yourmembership-laravel-api

YourMembership.com PHP API for Laravel

YourMembership-Laravel-API

This package in a work in progress, it is based on the code YM-API.

This package implements a PHP wrapper to work with http://www.yourmembership.com/company/api-reference/, _(*1)

Laravel Installation (5.2+)

Require this package with composer by adding the following to your composer file:, _(*2)

"require": {
    "coolcodemy/yourmembership-laravel-api": "^0.0.1"
},

Then run composer update to download the package., _(*3)

Or use, _(*4)

composer require coolcodemy/yourmembership-laravel-api

After updating composer, add the service provider to the providers array in config/app.php, _(*5)

CoolCodeMY\YourMembershipLaravelAPI\YourMembershipServiceProvider::class,

Publish the config for the package, _(*6)

php artisan vendor:publish --provider="CoolCodeMY\YourMembershipLaravelAPI\YourMembershipServiceProvider"

Fill in your API_KEY, SECRET_API_KEY and SA_PASSCODE inside config/yourmembership-laravel-api.php., _(*7)

Usage

<?php
...
use CoolCodeMY\YourMembershipLaravelAPI\YMLA;

class YourController extends Controller {

    public function index(YMLA $ymla)
    {
        // Array results
        $result = $ymla->call('Auth.Authenticate', [
            'Username' => 'email@examle.com',
            'Password' => 'password',
        ])->toArray();

        // JSON/Object result
        $result = $ymla->call('Auth.Authenticate', [
            'Username' => 'email@examle.com',
            'Password' => 'password',
        ])->toJson();

        // XML result
        $result = $ymla->call('Auth.Authenticate', [
            'Username' => 'email@examle.com',
            'Password' => 'password',
        ])->toXML();
    }
    ...
}

Notes on YourMembership session

You don't need to generate session for authentication as this package will do it for you. The SessionID is saved inside Laravel cache for 15 minutes., _(*8)

Returning the RAW XML results from YourMembership

This will return the results as XML and set the return header to XML for the browser to properly print valid XML., _(*9)

...
$result = $ymla->call('Auth.Authenticate', [
    'Username' => 'email@examle.com',
    'Password' => 'password',
])->toXML();

return response()->xml($result);
...