jetimob / asaas-sdk-php-laravel
Asaa API 的 Laravel SDK
v1.5.1
2024-09-19 14:17 UTC
Requires
- php: >=8.1
- ext-json: *
- ext-openssl: *
- illuminate/console: ^9.0 || ^10.0
- illuminate/container: ^9.0 || ^10.0
- illuminate/support: ^9.0 || ^10.0
- jetimob/http-php-laravel: ^2
Requires (Dev)
- orchestra/testbench: ^7.6.1 || ^8
README
Asaas Sdk Php Laravel
该 SDK 的目的是为了以简单直接的方式与 Asaas 的 API 通信,仅包含必要的功能。
安装
composer require jetimob/asaas-sdk-php-laravel
配置
开始之前,需要通过以下命令发布包的配置:
php artisan asaas:install
此命令将在 /config 目录下创建 asaas.php 配置文件,以便您可以根据项目需求进行修改。
API
- 客户 - ( 客户 )
- 收费 - ( 收费 )
- 账户 - ( 子账户 )
- Webhook - ( Webhook 配置 )
每次调用 asaas-sdk-php-laravel 包的任何 API 时,请使用命名空间 Jetimob\Asaas\Facades\Asaas 或简单地使用 Asaas。Asaas 命名空间由 Laravel 自动注册,因此只需在文件顶部使用 use Asaas; 即可导入。
示例
创建客户 (Customer)
use Jetimob\Asaas\Facades\Asaas; use Jetimob\Asaas\Entity\Customer\Customer; $customer = with(new Customer()) ->setName('John Doe') ->setEmail('teste@email.com') ->setCpfCnpj('00000000000'); $response = Asaas::customer()->create($customer);
认证
所有对 Asaas API 的请求都需要在请求头中包含 access_token,默认情况下,包将从 asaas.php 文件中恢复。
对于与子账户相关的请求,需要显式地传递令牌(在创建子账户后作为 ApiKey 返回)。
例如
$charging = new Charging(); /** * Dessa forma irá criar uma cobrança para a conta principal, * que possua a api key configurada no arquivo asaas.php. */ Asaas::charging()->create($charging); /** * Dessa forma será criada uma cobrança para essa conta que foi criada agora */ $account = new Account(); $response = Asaas::account()->create($account); $apiKey = $response->getApiKey(); Asaas::charging()->usingToken($apiKey)->create($charging);