PHPackages                             ae8/contaazul - 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. ae8/contaazul

ActiveLibrary[API Development](/categories/api)

ae8/contaazul
=============

ContaAzul API Library

1.5(1y ago)117MITPHPPHP >=7.1

Since Aug 7Pushed 1y ago1 watchersCompare

[ Source](https://github.com/arismarioneves/APIContaAzul)[ Packagist](https://packagist.org/packages/ae8/contaazul)[ Docs](https://github.com/arismarioneves/contaazul)[ RSS](/packages/ae8-contaazul/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (3)Used By (0)

APIContaAzul
============

[](#apicontaazul)

APIContaAzul é uma biblioteca PHP simples para integração com a API da Conta Azul, fornecendo métodos para autenticação e requisições aos endpoints desejados.

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

[](#descrição)

Esta biblioteca facilita a integração com a API da Conta Azul, automatizando o processo de autenticação OAuth2 e fornecendo métodos convenientes para realizar requisições aos diversos endpoints disponíveis na API. Ideal para quem precisa acessar e manipular dados como clientes, produtos, serviços, contratos e vendas na plataforma Conta Azul.

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

[](#instalação)

APIContaAzul está disponível no [Packagist](https://packagist.org/packages/ae8/contaazul), e a instalação via [Composer](https://getcomposer.org) é a forma recomendada de instalá-la. Basta adicionar a seguinte linha ao seu arquivo `composer.json`:

```
"ae8/contaazul": "^1.0"
```

Ou executar o seguinte comando no terminal:

```
composer require ae8/contaazul
```

Lembre-se que a pasta `vendor` e o script `vendor/autoload.php` são gerados pelo Composer; eles não fazem parte da biblioteca.

Como Usar
---------

[](#como-usar)

### Criando a Aplicação

[](#criando-a-aplicação)

O primeiro passo é criar uma aplicação no portal de desenvolvedores da Conta Azul através do [link](https://portaldevs.contaazul.com/). Após criar a aplicação, você terá acesso ao `client_id` e `secret_id` da sua aplicação.

**Nota:** Preste atenção à URL de redirecionamento que você definir ao criar sua aplicação, pois ela será utilizada na autenticação OAuth2.

### Iniciando a Autenticação

[](#iniciando-a-autenticação)

Primeiro, você precisa iniciar o processo de autenticação acessando a seguinte URL:

[`https://api.contaazul.com/auth/authorize?redirect_uri={redirect_uri}&client_id={client_id}&scope=sales&state={state}`](https://api.contaazul.com/auth/authorize?redirect_uri=%7Bredirect_uri%7D&client_id=%7Bclient_id%7D&scope=sales&state=%7Bstate%7D)

Onde:

- `redirect_uri`: Mesma URL definida na aplicação.
- `client_id`: O valor do `client_id` obtido ao criar a aplicação.
- `scope`: Define o tipo de acesso que você terá à API (`Customer`, `Product`, `Service`, `Contract`, `Sale`).
- `state`: Um valor definido por você que serve como chave de autenticidade do request.

### Usando a Biblioteca

[](#usando-a-biblioteca)

#### Instanciando a Classe

[](#instanciando-a-classe)

No arquivo PHP indicado na URL de redirecionamento, você precisa instanciar a classe da biblioteca:

```
$requireAutoload = __DIR__ . '/vendor/autoload.php';
require $requireAutoload;

use AE8\ContaAzul\ContaAzul;
use AE8\ContaAzul\Helpers\Helpers;

// Variáveis necessárias para inicialização
$client_id = "CLIENT_ID";
$client_secret = "SECRET_ID";
$redirect_uri = "URL_DE_REDIRECIONAMENTO";
$scope = "sales";
$state = Helpers::generateRandomString(16);

// Instanciando a classe
$apiContaazul = new ContaAzul($client_id, $client_secret, $redirect_uri, $scope, $state);
```

#### Negociando o Token

[](#negociando-o-token)

Agora, você deve capturar o código enviado pela Conta Azul no parâmetro `code` da URL de redirecionamento:

```
if (isset($_REQUEST['code'])) {
    $getToken = $apiContaazul->requestToken($_REQUEST['code']);
}
```

O método `requestToken` retornará os seguintes parâmetros:

- `access_token`
- `refresh_token`
- `expires_in`

Armazene esses valores em uma sessão para monitorar o tempo de expiração e renovar o token quando necessário.

### Renovando o Token

[](#renovando-o-token)

Quando o token expirar (após 60 minutos), você pode renová-lo facilmente com o método:

```
$getToken = $apiContaazul->requestToken($refresh_token);
```

### Usando a API

[](#usando-a-api)

Com o token em mãos, você pode fazer requisições à API da Conta Azul usando o método:

```
$request = $apiContaazul->request($endpoint, $parametros, $token, $metodo);
```

- `$endpoint`: O endpoint da API que você deseja acessar.
- `$parametros`: Parâmetros enviados na requisição.
- `$token`: O token de acesso gerado.
- `$metodo`: O método HTTP a ser usado (`get`, `post`, `put`, `delete`, `postjson`, `putjson`).

Desenvolvedor
-------------

[](#desenvolvedor)

- Arismário Neves (Mari05liM)

###  Health Score

22

—

LowBetter than 22% of packages

Maintenance34

Infrequent updates — may be unmaintained

Popularity7

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity36

Early-stage or recently created project

 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

Every ~0 days

Total

2

Last Release

647d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/5210fb30723d4145f11b6afa540a2f658ebaf89c610f00ba142ba4dbb6bb044c?d=identicon)[arismarioneves](/maintainers/arismarioneves)

---

Top Contributors

[![arismarioneves](https://avatars.githubusercontent.com/u/7850799?v=4)](https://github.com/arismarioneves "arismarioneves (2 commits)")

---

Tags

apicontaazul

### Embed Badge

![Health badge](/badges/ae8-contaazul/health.svg)

```
[![Health](https://phpackages.com/badges/ae8-contaazul/health.svg)](https://phpackages.com/packages/ae8-contaazul)
```

###  Alternatives

[m165437/laravel-blueprint-docs

API Blueprint Renderer for Laravel

22779.0k](/packages/m165437-laravel-blueprint-docs)

PHPackages © 2026

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