README

APIContaAzul 是一个用于集成 Conta Azul API 的简单 PHP 库，提供用于认证和请求所需端点的各种方法的库。

描述

这个库简化了与 Conta Azul API 的集成，自动化 OAuth2 认证过程，并提供方便的方法来执行对 API 中可用的各种端点的请求。适合需要访问和操作 Conta Azul 平台上的客户、产品、服务、合同和销售数据的人。

安装

APIContaAzul 可在 Packagist 上找到，通过 Composer 安装是推荐的安装方式。只需在您的 composer.json 文件中添加以下行

"ae8/contaazul": "^1.0"

或者，在终端中执行以下命令

composer require ae8/contaazul

请注意，文件夹 vendor 和脚本 vendor/autoload.php 是由 Composer 生成的；它们不是库的一部分。

如何使用

创建应用

第一步是创建一个应用，通过链接在 Conta Azul 开发者门户中进行。创建应用后，您将获得应用的 client_id 和 secret_id。

注意：请务必注意您在创建应用时设置的 URL 重定向，因为该 URL 将用于 OAuth2 认证。

开始认证

首先，您需要访问以下 URL 以开始认证过程

https://api.contaazul.com/auth/authorize?redirect_uri={redirect_uri}&client_id={client_id}&scope=sales&state={state}

其中

redirect_uri：与应用中定义的相同 URL。
client_id：创建应用时获得的 client_id 值。
scope：定义您将获得的 API 访问类型（Customer、Product、Service、Contract、Sale）。
state：您定义的一个值，作为请求的认证键。

使用库

实例化类

在重定向 URL 中指定的 PHP 文件中，您需要实例化库中的类

$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);

获取 Token

现在，您需要捕获 Conta Azul 发送到重定向 URL 的参数 code 中的代码

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

requestToken 方法将返回以下参数

access_token
refresh_token
expires_in

将这些值存储在会话中，以监控过期时间并在需要时更新 Token。

更新 Token

当 Token 过期（60 分钟后），您可以使用以下方法轻松更新它

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

使用 API

有了 Token，您可以使用以下方法向 Conta Azul API 发送请求

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

$endpoint：您要访问的 API 端点。
$parametros：请求中发送的参数。
$token：生成的访问 Token。
$metodo：要使用的 HTTP 方法（get、post、put、delete、postjson、putjson）。

开发者

Arismário Neves (Mari05liM) mariodev@outlook.com.br

ae8 / contaazul

维护者

详细信息