library controlpay-sdk

adrianolaselva/controlpay-sdk

, _(*1)

, _(*2)

, _(*3)

Componente de integração com API de ControlPay plataforma

Este Projeto tem por finalidade prover uma integração menos traumática e padronizada com as API's do ControlPay, _(*4)

Descrição

Para iniciar o uso os seguintes passos devem ser executados, _(*5)

* Passar como parâmetro no construtor em forma de array.

$this->client = new \Integracao\ControlPay\Client([
    ControlPayParameterConst::CONTROLPAY_HOST => "http://...",
    ControlPayParameterConst::CONTROLPAY_TIMEOUT => 10,
    ControlPayParameterConst::CONTROLPAY_USER => "",
    ControlPayParameterConst::CONTROLPAY_PWD => "",
    ControlPayParameterConst::CONTROLPAY_KEY => "",
    ControlPayParameterConst::CONTROLPAY_DEFAULT_TERMINAL_ID => "",
    ControlPayParameterConst::CONTROLPAY_DEFAULT_PRODUTO_ID => "",
    ControlPayParameterConst::CONTROLPAY_DEFAULT_FORMA_PAGAMENTO_ID => "",
    ControlPayParameterConst::CONTROLPAY_DEFAULT_SENHA_TECNICA => "",
]);

$vendaApi = new VendaAPI($client);

* Passar como parâmetro a partir de uma instância do Client.

$client = new \Integracao\ControlPay\Client();

$client->setParameter(ControlPayParameterConst::CONTROLPAY_HOST, "http://...");
$client->setParameter(ControlPayParameterConst::CONTROLPAY_USER, "");
$client->setParameter(ControlPayParameterConst::CONTROLPAY_PWD, "");
$client->setParameter(ControlPayParameterConst::CONTROLPAY_TIMEOUT, 10);
$client->setParameter(ControlPayParameterConst::CONTROLPAY_KEY, "");
$client->setParameter(ControlPayParameterConst::CONTROLPAY_DEFAULT_TERMINAL_ID, "");
$client->setParameter(ControlPayParameterConst::CONTROLPAY_DEFAULT_PRODUTO_ID, "");
$client->setParameter(ControlPayParameterConst::CONTROLPAY_DEFAULT_FORMA_PAGAMENTO_ID, "");
$client->setParameter(ControlPayParameterConst::CONTROLPAY_DEFAULT_FORMA_AGUARDA_TEF, "");
$client->setParameter(ControlPayParameterConst::CONTROLPAY_DEFAULT_SENHA_TECNICA, "");

$vendaApi = new VendaAPI($client);

Parâmetros

ControlPayParameterConst::CONTROLPAY_HOST => URL das apis do controlPay
ControlPayParameterConst::CONTROLPAY_TIMEOUT => Tempo de Timeout da requisição, como padrão o tempo é de 20 segundos
ControlPayParameterConst::CONTROLPAY_USER => Usuário de acesso ao controlPay
ControlPayParameterConst::CONTROLPAY_PWD => Senha de acesso ao controlPay
ControlPayParameterConst::CONTROLPAY_KEY => Chave de acesso ao controlPay
ControlPayParameterConst::CONTROLPAY_DEFAULT_TERMINAL_ID => Código do terminal que para acionamento do tef
ControlPayParameterConst::CONTROLPAY_DEFAULT_PRODUTO_ID => Código do produto padrão
ControlPayParameterConst::CONTROLPAY_DEFAULT_FORMA_PAGAMENTO_ID => Código de forma de pagamento padrão
ControlPayParameterConst::CONTROLPAY_DEFAULT_FORMA_AGUARDA_TEF => Transacionar com tef
ControlPayParameterConst::CONTROLPAY_DEFAULT_SENHA_TECNICA => Senha técnica para cancelamento de transação, aconselhável que ela não seja fixada no arquivo de configurações

Obs: Caso seja adicionado a "CONTROLPAY_KEY" no parâmetro, não será necessário os parâmetros "CONTROLPAY_USER" e "CONTROLPAY_PWD", pois os mesmos são utilizados para gerar uma key para efetuar as requisições, _(*6)

Para obter a versão configure seu composer.json conforme exemplo abaixo:, _(*7)

{
    "name": "controlpay/composer-consumer",
    "authors": [
        {
            "name": "Adriano M. La Selva",
            "email": "adrianolaselva@gmail.com"
        }
    ],
    "require": {
        "adrianolaselva/controlpay-sdk": "0.1.*"
    },
    "prefer-stable" : true
}

Certifique-se que as configurações foram preenchidas corretamente executando os testes presentes no diretório "/vendor/adrianolaselva/controlpay-sdk/tests/*", _(*8)

phpunit