fsdrasfragoso/asaas-sdk

Asaas API SDK。此SDK允许集成支付、订阅、通知等功能。

dev-master 2024-05-02 03:58 UTC

This package is auto-updated.

Last update: 2024-10-02 04:53:23 UTC


README

此SDK允许轻松将Asaas API集成到PHP项目中,以自动化收款、收取和付款流程。

安装

要安装SDK,请按照以下步骤操作:

  1. 确保您的开发环境中已安装Composer。

  2. 创建一个新项目或进入您希望集成SDK的现有项目。

  3. 打开终端并导航到您的项目目录。

  4. 执行以下命令通过Composer安装SDK:

composer require fsdrasfragoso/asaas-sdk

使用方法

安装SDK后,您可以使用以下方式在项目中使用它:

require_once 'vendor/autoload.php';

use Asaas\Api\Customers\CustomerService;
use Asaas\Customers\CustomerManager;
use Asaas\Api\Payments\PaymentService;
use Asaas\Payments\PaymentManager;

$apiKey = 'sua-chave-de-api';

$customerService = new CustomerService($apiKey);
$customerManager = new CustomerManager($customerService);

$customerData = [
    'name' => 'João Silva',
    'cpfCnpj' => '000.000.000-00',
    'email' => 'joao.silva@email.com',
    'phone' => '4730280400',
    'mobilePhone' => '47991234444',
    'address' => 'Rua Exemplo, 123',
    'postalCode' => '89223000'
];

$customer = $customerManager->createCustomer($customerData);

echo "Cliente criado com sucesso. ID: " . $customer->id;
$paymentService = new PaymentService($apiKey);
$paymentManager = new PaymentManager($paymentService);

$paymentData = [
    'customer' => $customer->id,
    'billingType' => 'BOLETO',
    'value' => 100.00,
    'dueDate' => '2024-05-05',
    'description' => 'Descrição da cobrança'
];

$payment = $paymentManager->create($paymentData);

echo "Cobrança criada com sucesso. ID: " . $payment->id;

使用Customer对象创建客户端

// Configuração do SDK já realizada anteriormente

// Criação do objeto Customer sem parâmetros iniciais no construtor
$customer = new Customer();
$customer->setName("Carlos Silva");
$customer->setCpfCnpj("111.222.333-44");
$customer->setEmail("carlos.silva@example.com");
$customer->setPhone("2133445566");
$customer->setMobilePhone("21988776655");
$customer->setAddress("Rua das Laranjeiras, 200");
$customer->setAddressNumber("20");
$customer->setComplement("Casa");
$customer->setProvince("Zona Sul");
$customer->setPostalCode("22000-000");
$customer->setExternalReference("54321");
$customer->setNotificationDisabled(true);
$customer->setAdditionalEmails("carlos.negocios@example.com");
$customer->setMunicipalInscription("654321789");
$customer->setStateInscription("321654987");
$customer->setObservations("Cliente atacadista");
$customer->setGroupName("Atacado");
$customer->setCompany("Carlos Frutas LTDA");

// Usando o CustomerManager para criar o cliente no Asaas
$result = $customerManager->createCustomer($customer);

if ($result) {
    echo "Cliente criado com sucesso. ID: " . $result->id;
} else {
    echo "Erro ao criar cliente.";
}

文档

有关可用方法和所需参数的更多信息,请参阅Asaas官方文档

SDK结构

以下是SDK的目录和文件结构:

  • src/
    • Api/
      • Payments/
        • PaymentService.php:实现与Asaas支付API的集成逻辑。
    • Payments/
      • PaymentManager.php:管理与收款相关的操作。
      • PaymentInterface.php:定义PaymentManager类的接口。
      • Payment.php:代表Asaas的收款。

贡献

如果您发现任何问题或想贡献改进,请随意在GitHub仓库中打开issue或发送pull request