PHPackages                             vitorccs/alterdata-bimer-php - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. vitorccs/alterdata-bimer-php

ActiveLibrary[API Development](/categories/api)

vitorccs/alterdata-bimer-php
============================

SDK PHP para a API do Alterdata Bimer

v1.2.2(5y ago)41.1k1[2 PRs](https://github.com/vitorccs/alterdata-bimer-php/pulls)GPL-3.0PHPPHP >=7.3.0

Since Jun 29Pushed 3y ago2 watchersCompare

[ Source](https://github.com/vitorccs/alterdata-bimer-php)[ Packagist](https://packagist.org/packages/vitorccs/alterdata-bimer-php)[ Docs](https://github.com/vitorccs/alterdata-bimer-php)[ RSS](/packages/vitorccs-alterdata-bimer-php/feed)WikiDiscussions master Synced 3w ago

READMEChangelog (7)Dependencies (2)Versions (16)Used By (0)

Alterdata Bimer - SDK PHP
=========================

[](#alterdata-bimer---sdk-php)

SDK PHP para a API do Alterdata Bimer

Descrição
---------

[](#descrição)

SDK em PHP para integração com os serviços de API do ERP Alterdata Bimer. Documentação da API Alterdata Bimer: .

Instalação
----------

[](#instalação)

Via Composer

```
composer require vitorccs/alterdata-bimer-php
```

Métodos disponíveis
-------------------

[](#métodos-disponíveis)

All: Buscar objetos. Retorna array de objetos.

```
$person = Bimer\PersonCharacteristic::all();
```

Find: Encontrar objetos por ID. Retorna objeto.

```
$person = Bimer\Person::find($strId);
```

Create - Criar novo objeto. Retorna objeto criado.

```
$customer = Bimer\Customer::create($arrayData);
```

Update - Atualiza objeto. Retorna objeto atualizado.

```
$person = Bimer\Person::update($strId, $arrayData);
```

Métodos específicos por recurso
-------------------------------

[](#métodos-específicos-por-recurso)

```
$postalCode = Bimer\PostalCode::getByCode('03943000');
$people = Bimer\Person::getByName('maria', true);
$people = Bimer\Person::getByCpfCnpj('123.456.789-01');
```

Variáveis de ambiente
---------------------

[](#variáveis-de-ambiente)

Os seguintes parâmetros devem ser informados:

- BIMER\_API\_URL (URL da API)
- BIMER\_API\_ID (ID do cliente)
- BIMER\_API\_SECRET (Segredo do cliente)
- BIMER\_API\_USER (Usuário)
- BIMER\_API\_PWD (Senha)
- BIMER\_API\_TIMEOUT (Opcional, padrão 30. Timeout em segundos para estabelecer conexão com a API)

Autenticação
------------

[](#autenticação)

Não é necessário codificar a variável BIMER\_API\_PWD com 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
------------------------

[](#exemplo-de-implementação)

```
error_reporting(E_ALL);
ini_set('display_errors', 1);

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

putenv('BIMER_API_URL=http://path:8086/api/');
putenv('BIMER_API_ID=client_id');
putenv('BIMER_API_SECRET=client_secret');
putenv('BIMER_API_USER=username');
putenv('BIMER_API_PWD=password');

use Bimer\Exceptions\BimerApiException;
use Bimer\Exceptions\BimerRequestException;

try {
    $characteristics = Bimer\PersonCharacteristic::all();
    print_r($characteristics); // array of objects

    $person = Bimer\Person::find('00A0000SQ4');
    print_r($person); // object

    $person = Bimer\Person::update('00A0000SQ4', [
       'Nome' => 'Nome Completo2',
       'NomeCurto' => 'Nome Curto2'
    ]);
    print_r($person); // object

    $people = Bimer\Person::getByName('NOME', true);
    print_r($people); // array of objects

    $people = Bimer\Person::getByCpfCnpj('123.456.789-01');
    print_r($people); // array of objects

    $customer = Bimer\Customer::create([
        'Identificador' => '',
        'IdentificadorRepresentantePrincipal' => '',
        'Tipo' => 'F',
        'Codigo' => '',
        'CpfCnpj' => '01234567894',
        'DataNascimento' => '1980-04-26T00:00:00:000Z',
        'Nome' => 'Nome Completo',
        'NomeCurto' => 'Nome Curto'
    ]);
    print_r($customer); // object

} catch (BimerApiException $e) { // erros retornados pela API Bimer
    echo sprintf("%s (%s)", $e->getMessage(), $e->getErrorCode());
} catch (BimerRequestException $e) { // erros de servidor (erros HTTP 4xx e 5xx)
    echo sprintf("%s (%s)", $e->getMessage(), $e->getErrorCode());
} catch (\Exception $e) { // demais erros
    echo $e->getMessage();
}
```

Métodos implementados
---------------------

[](#métodos-implementados)

- CEP (PostalCode)
- Cliente (Customer)
- NaturezaLancamento (AccountInformation)
- Pessoa (Person)
- PessoaCaracteristica (PersonCharacteristic)
- Titulos a Receber (Income)
- TiposLogradouro (AreaType)

... por favor, contribua com mais implementações

Testes
------

[](#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âmtros ENV com os dados de seu acesso
3. Execute o comando abaixo no terminal dentro da pasta deste projeto:

```
composer test
```

###  Health Score

34

—

LowBetter than 75% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity24

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity66

Established project with proven stability

 Bus Factor1

Top contributor holds 96.6% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~89 days

Recently: every ~158 days

Total

13

Last Release

1848d ago

Major Versions

v0.9.4 → v1.02018-09-02

PHP version history (2 changes)v0.9PHP >=5.6.0

v1.2.0PHP >=7.3.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/2d5d2e771a97ac9dc5a1a1c8a18ec3cf97b5ea7872bfbc0fd62b060545cf6dfa?d=identicon)[vitorccs](/maintainers/vitorccs)

---

Top Contributors

[![vitorccs](https://avatars.githubusercontent.com/u/9891961?v=4)](https://github.com/vitorccs "vitorccs (28 commits)")[![adb-deploy](https://avatars.githubusercontent.com/u/125529745?v=4)](https://github.com/adb-deploy "adb-deploy (1 commits)")

---

Tags

alterdatabimer

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/vitorccs-alterdata-bimer-php/health.svg)

```
[![Health](https://phpackages.com/badges/vitorccs-alterdata-bimer-php/health.svg)](https://phpackages.com/packages/vitorccs-alterdata-bimer-php)
```

###  Alternatives

[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3661.2M46](/packages/tencentcloud-tencentcloud-sdk-php)[neuron-core/neuron-ai

The PHP Agentic Framework.

2.0k496.1k33](/packages/neuron-core-neuron-ai)[avalara/avataxclient

Client library for Avalara's AvaTax suite of business tax calculation and processing services. Uses the REST v2 API.

528.3M7](/packages/avalara-avataxclient)[eslazarev/wildberries-sdk

Wildberries OpenAPI clients (generated).

232.5k](/packages/eslazarev-wildberries-sdk)[files.com/files-php-sdk

Files.com PHP SDK

2478.1k](/packages/filescom-files-php-sdk)[aimeos/prisma

A powerful PHP package for integrating media related Large Language Models (LLMs) into your applications

1772.4k4](/packages/aimeos-prisma)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)