Skip to content

README-pt.md

Latest commit

 

History

History
126 lines (89 loc) · 2.52 KB

README-pt.md

File metadata and controls

126 lines (89 loc) · 2.52 KB
Raw

AbacatePay SDK

PyPI Version PyPI Downloads

Um SDK Python para simplificar a interação com a API do AbacatePay.
Esse SDK fornece ferramentas para gerenciamento de faturamento, gerenciamento de clientes e muito mais.
Suporte aos modos síncrono e assíncrono, de forma simplificada.

Inglês | Português

Índice

Instalação

Usando pip

pip install abacatepay

Usando Poetry

poetry add abacatepay

Iniciando

Para usar o SDK, importe-o e inicialize o cliente com sua chave de API:

import abacatepay

client = abacatepay.AbacatePay("<your-api-key>")

Exemplos de Uso

Criar uma fatura

from abacatepay.products import Product

products = [
    Product(
        external_id="123",
        name="Test Product",
        quantity=1,
        price=5000,
        description="Example product"
    ),
    # ou como um dicionário
    {
        'external_id': "321",
        'name': "Product as dict",
        'quantity': 1,
        'price': 10_00,
        'description': "Example using dict"
    }
]

billing = client.billing.create(
    products=products,
    return_url="https://yourwebsite.com/return",
    completion_url="https://yourwebsite.com/complete"
)

print(billing.data.url)

Listar todas as faturas

billings = client.billing.list()
for billing in billings:
    print(billing.id, billing.status)

print(len(billings))

Gerenciamento de clientes

from abacatepay.customers import CustomerMetadata

customer = CustomerMetadata(  # Também pode ser apenas um dicionário
    email="customer@example.com",
    name="Customer Name",
    cellphone="(12) 3456-7890",
    tax_id="123-456-789-10"
)

created_customer = client.customers.create(customer)
print(created_customer.id)

Contribuindo

Contribuições para o SDK do AbacatePay são muito bem-vindas! Para colaborar, siga as instruções do nosso guia de contribuição.

Tutoriais

Confira a seção de tutoriais na documentação: