README

Sdk for Gerencianet Pagamentos' API. For more informations about parameters and values, please refer to Gerencianet documentation.

Installation

Require this package with composer:

$ composer require gerencianet/gerencianet-sdk-php

Or include it in your composer.json file:

...
"require": {
  "gerencianet/gerencianet-sdk-php": "2.*"
},
...

Requirements

PHP >= 5.5

Tested with

php 5.5, 5.6, 7.0 and 7.1

Getting started

Require the module and namespaces:

require __DIR__ . '/../sdk/vendor/autoload.php';

use Gerencianet\Gerencianet;

Although the web services responses are in json format, the sdk will convert any server response to array. The code must be within a try-catch and exceptions can be handled as follow:

try {
  /* code */
} catch(GerencianetException $e) {
  /* Gerencianet's api errors will come here */
} catch(Exception $ex) {
  /* Other errors will come here */
}

For development environment

Instantiate the module passing using your client_id, client_secret and sandbox equals true:

$options = [
  'client_id' => 'client_id',
  'client_secret' => 'client_secret',
  'sandbox' => true,
  'timeout' => 30
];

$api = new Gerencianet($options);

For production environment

To change the environment to production, just set the third sandbox to false:

$options = [
  'client_id' => 'client_id',
  'client_secret' => 'client_secret',
  'sandbox' => false
  'timeout' => 30
];

$api = new Gerencianet($options);

Running tests

To run tests install PHPUnit and run the following command:

$ phpunit -c config.xml

Running examples

Update examples/config.json file with client_id and client_secret of your application.

You can run using any web server, like Apache or nginx, or simple start a php server as follow:

php -S localhost:9000

Then open any example in your browser.

⚠️ Some examples require you to change some parameters to work, like examples/charge/detail.php where you must change the id parameter.

Version Guidance

Additional Documentation

The full documentation with all available endpoints is in https://dev.gerencianet.com.br/.

License

MIT

reportei / gerencianet-sdk-php-fork

Maintainers

Details