Introdução

​

URL base

https://api.chargefy.io/v1

​

Métodos HTTP

​

Faça sua primeira requisição

export CHARGEFY_API_KEY="{{API_KEY}}"

curl "https://api.chargefy.io/v1/customers?limit=1" \
  -H "Authorization: Bearer $CHARGEFY_API_KEY"

const response = await fetch(
  "https://api.chargefy.io/v1/customers?limit=1",
  {
    headers: {
      Authorization: `Bearer ${process.env.CHARGEFY_API_KEY}`,
    },
  },
);

const customers = await response.json();
console.log(customers);

import os
import requests

response = requests.get(
    "https://api.chargefy.io/v1/customers?limit=1",
    headers={
        "Authorization": f"Bearer {os.environ['CHARGEFY_API_KEY']}"
    },
    timeout=30,
)
response.raise_for_status()

customers = response.json()
print(customers)

{
"object": "list",
"data": [],
"has_more": false,
"url": "/v1/customers"
}

​

Convenções importantes

• Objetos completos: criações, consultas, atualizações e ações bem-sucedidas retornam o objeto público completo.
• Paginação por cursor: listagens usam starting_after, ending_before e limit. Veja Paginação.
• Erros consistentes: falhas usam status HTTP e um código estável para tratamento programático. Veja Erros.
• Datas em ISO 8601: timestamps incluem data, hora e fuso. Veja Datas, fusos e moedas.
• Rastreabilidade: cada chamada pode ser investigada pelo request ID. Veja Requests.

​

Principais recursos

• Customers — identidade, contato, endereço de cobrança e meios de pagamento do comprador.
• Produtos e preços — catálogo usado em checkouts, links de pagamento e assinaturas.
• Checkout Sessions — tentativas de compra com experiência hospedada pela Chargefy.
• Payment Intents — ciclo de uma tentativa de pagamento.
• Assinaturas — cobranças recorrentes, faturas, períodos e mudanças de plano.
• Eventos — mudanças que podem ser acompanhadas por webhook.

​

Continue lendo