unipago/api-sdk-php

SDK de consumo da API do UniPago

1.0.2 2018-09-11 17:19 UTC

Requires

• php: >=5.6
• guzzlehttp/guzzle: ^6.3
• league/oauth2-client: ^2.2

Requires (Dev)

• lcobucci/jwt: ^3.2
• phpdocumentor/phpdocumentor: 2.*
• phpunit/phpunit: ^6.2
• vlucas/phpdotenv: ^2.5

CC-BY-SA-4.0

• Dev SaaS KingHost

• api
• sdk
• unipago

README

Esta biblioteca foi desenvolvida para facilitar a utilização da API do Unipago, oferencendo todos os recursos disponíveis de forma prática e simplificada. Para a correta utilização deste SDK, é necessária a utilização da Linguagem PHP com versão igual ou superior a 5.6.0. Documentação das entradas e saidas

Instalação

Você pode utilizar o Composer ou simplesmente Efetuar o Download

Composer

Orientamos a instalação pelo composer. Siga as instruções de instalação se você ainda não tiver o composer instalado. Uma vez instalado o composer, execute o seguinte comando na raíz do seu projeto para instalar o pacote:

    composer require unipago/api-sdk-php

Finalmente, tenha certeza de incluir o autoloader:

    require_once '/path/to/your-project/vendor/autoload.php';

Autenticação com OAuth2

Utilizamos a tecnologia OAuth2 para autenticação do sistema. Para gerar as chaves de autenticação no sistema você deve acessar o UniPago. Para testar as suas chaves, você pode utilizar o script de exemplo abaixo:

<?php
/**
* Carregando o autoload
*/
require __DIR__ . '/../vendor/autoload.php';

/**
* Importando as classes
*/
use UnipagoApi\Connection;

/**
 * Aqui devem ser informados seu client_id e client_secret
 * que podem ser gerados no Unipago
 */
$client_id = 'CLIENT_ID';
$client_secret = 'CLIENT_SECRET';

/**
 * Deve ser informado o ambiente que deseja utilizar Connection::SCOPE_SANDBOX
 * ou Connection::SCOPE_PRODUCTION
 */
$conexao = new Connection(Connection::SCOPE_SANDBOX, $client_id, $client_secret);

echo "<pre>Access_token: <br />";
print_r($conexao->accessToken);
echo "</pre>";

Exemplo Básico

Listando Clientes

<?php
/**
* Carregando o autoload
*/
require __DIR__ . '/../vendor/autoload.php';

/**
* Importando as classes
*/
use UnipagoApi\Connection;
use UnipagoApi\Resource;

/**
* Aqui devem ser informados seu client_id e client_secret 
* que podem ser gerados no Unipago
*/
$client_id = 'SEU CLIENT ID';
$client_secret = 'SEU CLIENT SECRET';

/**
* Deve ser informado o ambiente que deseja utilizar Connection::SCOPE_SANDBOX
* ou Connection::SCOPE_PRODUCTION  
*/
$conexao = new Connection(Connection::SCOPE_SANDBOX, $client_id, $client_secret);

/**
* Instância do recurso de Cliente que será utilizada, onde deve ser passada a conexão
 */
$recursoCliente = new Resource\Cliente($conexao);

/**
* Retorna todos os clientes cadastrados no formato JSON
*/
$clientes = $recursoCliente->listar();

print_r($clientes);