README

Pagar.me - Laravel

Integração da API Pagar.me com o framework Laravel.

📚 Índice

Instalação
Configuração
Como usar
Endpoints disponíveis
Créditos
Licença

Instalação

Você pode instalar o pacote via composer.

composer require keepcloud/pagarme-laravel

Configuração

Antes de começar a utilizar o pacote, adicione sua chave de API no arquivo .env da aplicação:

PAGARME_API_KEY=ak_test_sua_chave_aqui

Em seguida, certifique-se de que o arquivo de configuração config/pagarme.php esteja publicado e corretamente configurado. Ele será responsável por armazenar os dados de conexão com a API do Pagar.me:

config/pagarme.php

<?php

return [
    'api_key'     => env('PAGARME_API_KEY', 'ak_test_*'),
    'base_url'    => 'https://api.pagar.me/core',
    'api_version' => 'v5',
];

Se você ainda não publicou o arquivo de configuração, execute o comando abaixo:

php artisan vendor:publish --tag="pagarme-config"

Esse passo é essencial para garantir que a integração com a API funcione corretamente, utilizando a chave de autenticação e a URL base da API do Pagar.me.

Como usar

Adicione o import no local onde desejar utilizar o pacote:

use Pagarme;

Exemplo de uso:

$customers = Pagarme::customer()->all();

$customersArray = json_decode($customers->getBody()->getContents(), true);

dd($customersArray);

Endpoints

Consulte as funções disponíveis para interagir com a API do Pagar.me.

Módulo	Descrição	Documentação
Customer	Gerenciamento de clientes, cartões e endereços	Ver detalhes
Charge	Cobranças e captura de pagamentos	Ver detalhes
Order	Criação e controle de pedidos e itens	Ver detalhes
Recipients	Gerenciamento de recebedores/destinatários	Ver detalhes
Subscription	Assinaturas e faturamento recorrente	Ver detalhes
Anticipation	Antecipação de recebíveis	Ver detalhes

Créditos

Keepcloud

Licenca

Licença MIT (MIT). Por favor, consulte o Arquivo de Licença para mais informações.

keepcloud / pagarme-laravel

Maintainers

Details