Download the PHP package vitorccs/procob-api-php without Composer
On this page you can find all versions of the php package vitorccs/procob-api-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download vitorccs/procob-api-php
More information about vitorccs/procob-api-php
Files in vitorccs/procob-api-php
Package procob-api-php
Short Description SDK PHP para a API da Procob S/A
License GPL-3.0
Homepage https://github.com/vitorccs/procob-api-php
Informations about the package procob-api-php
Procob API - SDK PHP
SDK em PHP para consulta a API RESTful da Procob S.A.
Descrição
SDK em PHP para consulta a API RESTful da Procob S.A. Documentação da API da Procob S/A
Instalação
Via Composer
Parâmetros
Parâmetro | Obrigatório | Padrão | Comentário |
---|---|---|---|
PROCOB_API_USER | Sim | - | Usuário da API para autenticar. |
PROCOB_API_PWD | Sim | - | Senha da API para autenticar. Se omitido, será usuado o de teste. |
PROCOB_API_TIMEOUT | Não | 30 | Timeout em segundos para estabelecer conexão com a API |
Como usar
1) Os parâmetros podem ser definidos por váriaveis de ambiente:
ou passados por array
:
2) Em seguida, basta utilizar qualquer um dos métodos disponíveís:
Você poderá usar o usuário e senha de testes da Procob ([email protected] | TesteApi), porém, os dados retornados pela API são todos fictícios
Métodos disponíveis
Normalização de dados
- Os dados de CPF e CNPJ podem ser passados no formato número ou texto, com ou sem máscaras.
- Os números de CPF e CNPJ sempre passam por validação de dados da própria SDK, evitando com isso consumir uma requisição a API.
- A SDK reconhece automaticamente quando a API da Procob não teve sucesso (código diferente de "000") e nestes casos, lança uma "exceção" (Exception) com a mensagem de erro.
Exemplo de implementação
Testes
Caso queira contribuir, por favor, implementar testes de unidade em PHPUnit.
Para executar: