README

Requirements

PHP 7.0.1 and later.

Composer

You can install the bindings via Composer. Run the following command:

composer require gopague/gopague-php

To use the go pague classes, use Composer's autoload:

require_once('vendor/autoload.php');

Dependencies

This library require the following extension in order to work properly:

curl, although you can use your own non-cURL client if you prefer
json (JSON handler)
mbstring (Multibyte String)

If you use Composer, these dependencies should be handled automatically. If you install manually, you'll want to make sure that these extensions are available.

Getting Started

First you need set the email and password of the user to login to Go Pague API.

GoPague\Http\Client::setEmail('myemail@foo.bar')
GoPague\Http\Client::setPassword('secret');

Now you can use the resource binding classes to interact with Go Pague API.

// gets the list of banks
$banks = GoPague\Bank::all();

Note: See Resource Binding Classes section to know all classes and methods available.

The binding classes will automatically use the previous given email and password to login and autenticate to the API before the first API request.

But if you want to autenticate to API manually, just use:

$credential = GoPague\Http\Client::login('myemail@foo', 'secret');

// gets the list of banks
$banks = GoPague\Bank::all();
// ...

You can access the Logged User data any time just calling the method:

$credencial = GoPague\Http\Client::credential();

echo $credential->token;   // the Authenticated Token
echo $credential->userId;   // the Authenticated User Id
echo $credential->clientIds;   // The client ids linked to the Authenticted User

Resource Binding Classes

@todo

Development

Install dependencies:

composer install

Tests

Install dependencies as mentioned above (which will resolve PHPUnit), then you can run the test suite:

./vendor/bin/phpunit

License

The GoPague PHP Library is open-sourced software licensed under the MIT license.

gopague / gopague-php

Maintainers

Details