Download the PHP package vitorccs/alterdata-bimer-php without Composer
On this page you can find all versions of the php package vitorccs/alterdata-bimer-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download vitorccs/alterdata-bimer-php
More information about vitorccs/alterdata-bimer-php
Files in vitorccs/alterdata-bimer-php
Package alterdata-bimer-php
Short Description SDK PHP para a API do Alterdata Bimer
License GPL-3.0
Homepage https://github.com/vitorccs/alterdata-bimer-php
Informations about the package alterdata-bimer-php
Alterdata Bimer - SDK PHP
SDK PHP para a API do Alterdata Bimer
Descrição
SDK em PHP para integração com os serviços de API do ERP Alterdata Bimer. Documentação da API Alterdata Bimer: https://bimer-api-docs.alterdata.com.br.
Instalação
Via Composer
Métodos disponíveis
All: Buscar objetos. Retorna array de objetos.
Find: Encontrar objetos por ID. Retorna objeto.
Create: Criar novo objeto. Retorna objeto criado.
Update: Atualiza objeto. Retorna objeto atualizado.
Métodos específicos por recurso
Variáveis de ambiente
Os seguintes parâmetros devem ser informados:
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
| BIMER_API_URL | Sim | URL da API |
| BIMER_API_ID | Sim | ID do cliente |
| BIMER_API_SECRET | Sim | Segredo do cliente |
| BIMER_API_USER | Sim | Usuário |
| BIMER_API_PWD | Sim | Senha |
| BIMER_API_TIMEOUT | Não | Timeout em segundos da conexão com a API (padrão: 30) |
Autenticação
- Não é necessário codificar a variável
BIMER_API_PWDcom MD5, a SDK fará isso automaticamente. - Não é necessário autenticar manualmente, O SDK irá autenticar e obter um token automaticamente.
- Cada processo PHP possuirá o seu próprio token de autenticação, sendo reaproveitado até o término da execução do script PHP. Caso esteja executando o PHP sem timeout (ex: CLI), o token será trocado a cada 10 minutos. Desta forma, evitamos sobrecarga no servidor da API.
Exemplo de implementação
Métodos implementados
- CEP (PostalCodeService)
- Cliente (CustomerService)
- NaturezaLancamento (AccountInformationService)
- Pessoa (PersonService)
- PessoaCaracteristica (PersonCharacteristicService)
- Titulos a Receber (IncomeService)
- TiposLogradouro (AreaTypeService)
... por favor, contribua com mais implementações
Testes
Caso queira contribuir, por favor, implementar testes em PHPUnit.
Para executar:
1) Faça uma cópia de phpunit.xml.dist em phpunit.xml na raíz do projeto
2) Altere os parâmetros ENV com os dados de seu acesso
3) Execute o comando abaixo no terminal dentro da pasta deste projeto:
Os testes estão separados em tests/Unit (não acessam a API) e tests/Integration (acessam a API). Os testes de integração são ignorados automaticamente enquanto BIMER_API_URL não contiver uma URL válida. Também é possível executar cada suíte separadamente: