README

This package provides a simple and elegant way to integrate Laravel applications with Conta Azul's API, offering an easy-to-use service and facade.

Features

Easy integration with Conta Azul API.
Laravel ServiceProvider for easy registration.
Facade for convenient access to the service.
Customizable through Laravel configuration files.

Requirements

PHP >= 8.3
Laravel >= 10

Installation

Require the package using Composer:

composer require eliseusantos/laravel-contaazul

Publish the configuration file:

php artisan vendor:publish --provider="EliseuSantos\ContaAzul\Providers\ContaAzulServiceProvider"

This command publishes the contaazul.php configuration file to your Laravel application's config directory.

Configuration

After publishing the configuration file, you can find it at config/contaazul.php. You'll need to set your Conta Azul API credentials here:

CONTA_AZUL_BASE_URI="https://api.contaazul.com"
CONTA_AZUL_CLIENT_ID="your_token_here"
CONTA_AZUL_CLIENT_TOKEN="your_token_here"

Add these lines to your .env file and replace "your_token_here" with your actual Conta Azul API token.

Usage

After setting up your configuration, you can use the Conta Azul service throughout your Laravel application. Here's an example of listing customers using the Conta Azul facade:

use EliseuSantos\ContaAzul\Facades\ContaAzul as ContaAzul;

$customers = ContaAzul::customer()->getCustomers();

Support us

We invest a lot in creating open source packages, and would be grateful for a sponsor if you make money from your product that uses them.

Updates & Issues

We only accept Issues through Github

We update security and bug fixes as soon as we can, other pull requests and enhancements will be as and when we can do them.

You can follow us on Linkedin where we will post any major updates. Linkedin You can follow us on Twitter where we will post any major updates. Twitter You can follow us on Blog where we will post any major updates. Site

To Do's

Documentation Site
Tests

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security-related issues, please email s.eliseu@proton.me instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

eliseusantos / laravel-contaazul

Maintainers

Details