https://github.com/bfgasparin/gopague-php

Go Pague Resource Binding Classes
https://github.com/bfgasparin/gopague-php

gopague php-7

Last synced: about 2 months ago
JSON representation

Go Pague Resource Binding Classes

• Host: GitHub
• URL: https://github.com/bfgasparin/gopague-php
• Owner: bfgasparin
• License: mit
• Created: 2017-01-23T13:02:42.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-05-15T14:49:44.000Z (over 7 years ago)
• Last Synced: 2024-10-13T12:21:49.808Z (3 months ago)
• Topics: gopague, php-7
• Language: PHP
• Size: 31.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Go Pague PHP Library

## Requirements

PHP 7.0.1 and later.

## Composer

You can install the bindings via [Composer](http://getcomposer.org/). Run the following command:

```bash

composer require gopague/gopague-php

```

To use the go pague classes, use Composer's [autoload](https://getcomposer.org/doc/00-intro.md#autoloading):

```php

require_once('vendor/autoload.php');

```

## Dependencies

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

- [`curl`](https://secure.php.net/manual/en/book.curl.php), although you can use your own non-cURL client if you prefer

- [`json`](https://secure.php.net/manual/en/book.json.php) (JSON handler)

- [`mbstring`](https://secure.php.net/manual/en/book.mbstring.php) (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.

```php

GoPague\Http\Client::setEmail('[email protected]')

GoPague\Http\Client::setPassword('secret');

```

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

```php

// 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:

```php

$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:

```php

$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:

``` bash

composer install

```

## Tests

Install dependencies as mentioned above (which will resolve [PHPUnit](http://packagist.org/packages/phpunit/phpunit)), then you can run the test suite:

```bash

./vendor/bin/phpunit

```

## License

The GoPague PHP Library is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).