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

ActiveLibrary[API Development](/categories/api)

leonardo-max/contaazul
======================

ContaAzul API

1.0(4y ago)046MITPHPPHP >=5.3

Since May 3Pushed 3y agoCompare

[ Source](https://github.com/leonardo-max/conta-azul-api)[ Packagist](https://packagist.org/packages/leonardo-max/contaazul)[ RSS](/packages/leonardo-max-contaazul/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (2)DependenciesVersions (2)Used By (0)

CONTA AZUL API
==============

[](#conta-azul-api)

Esta estrutura trata a integração com a api da conta azul, fornecendo métodos para autenticação, e request aos endpoint desejados.

INSTALAÇÃO
----------

[](#instalação)

composer require eudovic/contaazul:dev-master

COMO USAR
---------

[](#como-usar)

#### CRIANDO A APLICAÇÃ0

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

O primeiro passo é criar uma apicação no portal de desenvolvedores da conta azul através do seguinte link . Após criar a aplicação você será redirecionado a uma tela semelhante a imagem abaixo, onde terá acesso ao client\_id e secret\_id da sua aplicação.

[![](https://camo.githubusercontent.com/c70df303f3d60eb633d1a070f7ac2f98f1e65827745b10202ead27eefc58ce83/687474703a2f2f7777772e636f6e65637465732e636f6d2e62722f6769745f696d67735f646f63732f636f6e7461617a756c2f74656c61636f6e74617a756c2e6a7067)](https://camo.githubusercontent.com/c70df303f3d60eb633d1a070f7ac2f98f1e65827745b10202ead27eefc58ce83/687474703a2f2f7777772e636f6e65637465732e636f6d2e62722f6769745f696d67735f646f63732f636f6e7461617a756c2f74656c61636f6e74617a756c2e6a7067)

Note que um ponto de muita atenção na criação da sua aplicação neste portal é a URL de redirecionamento, pois sendo a autenticação feita em OAuth2, o código de acesso ao token será enviada a esta URL para que então possa fazer o requerimento do token e passar a ter acesso aos endpoints de consulta e manipulação. No entanto, não se preocupe com toda esta troca de informações, pois esta biblioteca cuidará do processo de autenticação facilmente se vc seguir os passos abaixo.

#### USANDO A BIBLIOTECA

[](#usando-a-biblioteca)

###### INICIANDO A AUTENTICAÇÃO

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

Primeiramente é preciso fazer a chamada de início do processo de autenticação. Pra isso é preciso invocar 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)

Abaixo uma descrição de cada um dos parâmetros.

- redirect\_uri : Mesma URL definida na aplicação.
- client\_id: Valor no honônimo parametro recebido pela aplicação.
- scope: (Customer, Product, Service, Contract ou Sale) Define o tipo de acesso que você tem a API.
- state: Valor definido pelo desenvolvedor que servirá como chave de autenticidade do request. Ex: state=DCEeFWf45A53sdfKef424

###### INSTANCIANDO A CLASSE

[](#instanciando-a-classe)

No seu arquivo php indicado na URL de redirecionamento é preciso instanciar a classe. Exemplo de implementação da bibioteca.

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

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

//VARIÁVEIS NECESSÁRIAS PARA INICIALIZAÇÃ0
$client_id="SEU_CLIENT_ID";
$client_secret="SEU_SECRET_ID";
$redirect_uri="URL_DE_REDIRECIONAMENTO";// pega a url atual para negociar os pedidos da 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 fazer uma verificação do request para capturar o código enviado pela conta AZUL no parametro ***code*** .

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

Ao usar o métido requestToken você terá como retorno os seguintes parâmetros:

- access\_token
- refresh\_token
- expire\_in

Para deixar o seu processo organizado e com boa performace, considere guardar este retorno em uma session, assim você poderá verificar posteriormente o tempo restante para expiracão do token, assim como ter acesso ao refresh\_token, que será usado na renovação do token

##### RENOVANDO O TOKEN

[](#renovando-o-token)

Bem provavelmente durante o uso do API o seu token deverá expirar, tendo em vista que o seu *lifetime* é de apenas 60 min. Não se preocupe, você poderá facilmente renovar o seu token usando o método abaixo:

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

###### USANDO A API

[](#usando-a-api)

Agora, em posse do token é possivel fazer as requisições usando o método abaixo.

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

- $endpoint // endpoint de consulta
- $parametros // parametros enviados ao request
- $token // token gerado
- $metodo // get-post-put-delete-postjson(para post com json como raw data)-putjson(para put com json como raw data)

###  Health Score

22

—

LowBetter than 22% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity8

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity43

Maturing project, gaining track record

 Bus Factor1

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

1469d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/d3b1e50e9a1dc7f4142c07c019ee8dac595ce2824422d859dc5f461b3f45ca91?d=identicon)[Leonardo-Max](/maintainers/Leonardo-Max)

---

Top Contributors

[![eudovic](https://avatars.githubusercontent.com/u/31167386?v=4)](https://github.com/eudovic "eudovic (15 commits)")[![leonardo-max](https://avatars.githubusercontent.com/u/11234838?v=4)](https://github.com/leonardo-max "leonardo-max (5 commits)")[![leonardoweslei](https://avatars.githubusercontent.com/u/942453?v=4)](https://github.com/leonardoweslei "leonardoweslei (1 commits)")

---

Tags

apicontaazul

### Embed Badge

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

```
[![Health](https://phpackages.com/badges/leonardo-max-contaazul/health.svg)](https://phpackages.com/packages/leonardo-max-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)