PHPackages                             zipline/egestor-sdk - 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. zipline/egestor-sdk

ActiveLibrary

zipline/egestor-sdk
===================

Sdk para acesso da API do eGestor

1.0.1(8y ago)370MITPHPPHP &gt;=5.5

Since Jul 25Pushed 8y ago1 watchersCompare

[ Source](https://github.com/eGestor/egestor-sdk-php)[ Packagist](https://packagist.org/packages/zipline/egestor-sdk)[ RSS](/packages/zipline-egestor-sdk/feed)WikiDiscussions master Synced today

READMEChangelogDependencies (3)Versions (2)Used By (0)

eGestor SDK para PHP
====================

[](#egestor-sdk-para-php)

SDK para simplificar o acesso da API do [eGestor](https://www.egestor.com.br/)

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

[](#instalação)

Utilize o [Composer](https://getcomposer.org) para instalar:

```
# Instalando o Composer
curl -sS https://getcomposer.org/installer | php

# Instalando o zipline/egestor-sdk como uma dependência do projeto
php composer.phar require zipline/egestor-sdk
```

Quando o SDK estiver instalado, será necessário carregar o `autoloader` gerado pelo Composer (arquivo responsável por carregar todos os *namespaces* ).

Adicione no seu arquivo:

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

Autenticando seu aplicativo
---------------------------

[](#autenticando-seu-aplicativo)

Existem duas formas principais para realizar a autenticação:

### Código de Acesso

[](#código-de-acesso)

O usuário será redirecionado para a url da sua aplicação com o parâmetro `code` que deverá ser utilizado para iniciar a autenticação com a API.

```
$code = $_GET['code'];

$api = new Zipline\eGestor\API([
  'clientId' => 'id_da_aplicacao',
  'clientSecret' => 'segredo',
  'redirectUri' => 'uri_cadastrada'
]);

$tokens = $api->authByCode($code);
```

Como resposta a API irá enviar três tokens `access_token`, `refresh_token` e `personal_token`.

Para os próximos acessos acesso utilize o `personal_token` para solicitar o conjunto de `access_token` e `refresh_token`.

O SDK possui um método para retornar o link de solicitação de acesso para sua aplicação:

```
$api = new Zipline\eGestor\API([
  'clientId' => 'id_da_aplicacao',
  'clientSecret' => 'segredo',
  'redirectUri' => 'uri_cadastrada'
]);

$url = $api->getAuthUri();
```

Sempre que o usuário acessar sua aplicação pelo link de redirecionamento, o sistema irá gerar um novo `code`;

### Personal Token

[](#personal-token)

Depois de realizada a primeira autenticação é possível utilizar o `personalToken` recebido para solicitar um novo `access_token`.

O `personalToken` identifica sua aplicação com o usuário do eGestor.

```
$api = new Zipline\eGestor\API(['personalToken' => PERSONAL_TOKEN]);
```

Acessando a API
---------------

[](#acessando-a-api)

Depois de feita a autenticação será possível acessar a API. Os métodos acesitos são `get`, `post`, `put` e `delete`. Sempre que possível o retorno será em formato `Array`.

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

$api = new Zipline\eGestor\API(['personalToken' => PERSONAL_TOKEN]);

$contatos = $api->get('contatos');
var_dump($contatos);
// Resposta:
// array(10) {
//   ["total"] => int(1)
//   ["per_page"]=> int(50)
//   ["current_page"]=>  int(1)
//   ["last_page"]=>  int(1)
//   ["next_page_url"]=>  NULL
//   ["prev_page_url"]=>  NULL
//   ["from"]=>   int(1)
//   ["to"]=>  int(50)
//   ["data"]=> array(1) {
//     [0]=> array(8) {
//       ["codigo"] =>  int(1)
//       ["nome"]   =>  string(5) "Paulo"
//       ["tipo"]   =>  array(1) {
//           [0]=>  string(7) "cliente"
//       }
//       ["emails"] =>  array(1) {
//         [0]=> string(17) "paulo@example.com"
//       }
//       ["fones"]  =>  array(0) {}
//       ["cidade"] =>  string(0) ""
//       ["uf"]     =>  string(0) ""
//       ["tags"]   =>  array(1) {
//         [0]=> string(11) "cliente-vip"
//       }
//     }
//   }
//   ["next_page"]=> NULL
// }
```

O objeto da API permite acessar dados da última requisição:

```
$remaining = $api->getRemaining();//número que requests até atingir o limite

$body = $api->getBody();//corpo da resposta sem o parser
```

Exemplos:

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

$api = new Zipline\eGestor\API(['personalToken' => PERSONAL_TOKEN]);

//Novo contato
$contato = $api->post("contatos", [
    'nome' => 'Zipline',
    'tipo' => ['fornecedor']
]);
$codContato = $contato['codigo'];

//Editando
$response = $api->put("contatos/$codContato", [
    'nome' => 'eGestor',
]);

//Removendo
$response = $api->delete("contatos/$codContato");

//Pesquisando
$response = $api->get("contatos", [
    'filtro' => 'eGestor',
]);
```

```
require 'vendor/autoload.php';
try {
  $api = new Zipline\eGestor\API(['personalToken' => PERSONAL_TOKEN]);

  $contatos = $api->get("contatos");

  foreach($contato as $contatos['data']) {
    echo $contato['codigo'] . ' - ' . $contato['nome'] . "\n";
  }

} catch(Zipline\Exception\InvalidTokenException $e) {
  echo "Não foi possível autenticar! Motivo:" . $e->getMessage() . "\n";
} catch(Exception $e) {
  echo "Requisição não poder realizada! Motivo:" . $e->getMessage() . "\n";
}
```

```
require 'vendor/autoload.php';
try {
  $api = new Zipline\eGestor\API([
  'app_id' => MEU_APP_ID,
  'app_secret' => MEU_APP_SECRET
  'personalToken' => PERSONAL_TOKEN)
  ]);

  $contatos = $api->get("contatos");

  foreach($contato as $contatos['data']) {
    echo $contato['codigo'] . ' - ' . $contato['nome'] . "\n";
  }

} catch(Zipline\Exception\InvalidTokenException $e) {
  echo "Não foi possível autenticar! Motivo:" . $e->getMessage() . "\n";
} catch(Exception $e) {
  echo "Requisição não poder realizada! Motivo:" . $e->getMessage() . "\n";
}
```

Exceptions
----------

[](#exceptions)

- `Zipline\Exception\InvalidTokenException`: credenciais inválidas;

###  Health Score

27

—

LowBetter than 52% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity12

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity58

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% 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

Unknown

Total

1

Last Release

3161d ago

### Community

Maintainers

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

---

Top Contributors

[![egestorZipline](https://avatars.githubusercontent.com/u/30440202?v=4)](https://github.com/egestorZipline "egestorZipline (5 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/zipline-egestor-sdk/health.svg)

```
[![Health](https://phpackages.com/badges/zipline-egestor-sdk/health.svg)](https://phpackages.com/packages/zipline-egestor-sdk)
```

PHPackages © 2026

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