Fintra
Início

Para programadores

A API da Fintra

Lê e escreve dados de negócio na Fintra sem pedir a ninguém para exportar nada. Clientes, produtos, facturas e pagamentos, por HTTP.

Chave por empresa. Âmbitos por recurso. Escritas idempotentes.

O acesso à API está nos planos Growth e Premium. A chave é emitida na conta da empresa que vais integrar.

Começar

Uma chave, um cabeçalho, e já está

A chave é emitida pelo dono da empresa, e vê apenas os dados dela.

# Confirmar que a chave funciona
curl https://api.fintra.co.mz/api/v1/partner/ping \
  -H "Authorization: Bearer fintra_sk_live_..."

# Listar clientes
curl https://api.fintra.co.mz/api/v1/partner/customers \
  -H "Authorization: Bearer fintra_sk_live_..."

# Criar uma factura. Toda a escrita exige Idempotency-Key.
curl -X POST https://api.fintra.co.mz/api/v1/partner/invoices \
  -H "Authorization: Bearer fintra_sk_live_..." \
  -H "Idempotency-Key: 8f3c1e90-4a2b-..." \
  -H "Content-Type: application/json" \
  -d '{"customer_id": 42, "items": [ ... ]}'

Com a chave vai o domínio, a documentação completa e um ambiente de teste onde podes partir tudo. O endereço acima é ilustrativo.

Endpoints

O que está aberto hoje

Leitura em cinco recursos, escrita em três. É o que existe, e não uma lista de intenções.

GET/v1/partner/pingconfirma a chave · customers:read
GET/v1/partner/customerslista e detalhe · customers:read
GET/v1/partner/productslista e detalhe · products:read
GET/v1/partner/invoiceslista e detalhe · invoices:read
GET/v1/partner/paymentslista e detalhe · payments:read
POST/v1/partner/customerscriar · customers:write
PUT/v1/partner/customers/{id}actualizar · customers:write
POST/v1/partner/productscriar · products:write
PUT/v1/partner/products/{id}actualizar · products:write
POST/v1/partner/invoicescriar · invoices:write

As regras

Quatro coisas que vais notar

A chave é de uma empresa só

Não há chaves globais. Cada uma é do dono de uma empresa e vê só os dados dela. Dez clientes, dez chaves.

Âmbitos por recurso, verificados antes do efeito

Uma chave com invoices:read não cria facturas. A autorização corre antes de qualquer escrita acontecer, e não depois de ter acontecido.

Toda a escrita exige Idempotency-Key

Sem ela, a escrita é recusada. Com ela, repetir o pedido não duplica nada. Numa rede que cai a meio, isso deixa de ser detalhe.

É servidor para servidor

Um pedido vindo de um browser é recusado. A chave nunca deve viver no JavaScript de uma página, e a API torna isso inútil.

Diz-nos o que estás a construir.

Emitimos uma chave de teste e mandamos a documentação. Se o que precisas não está aberto, queremos saber.

Falar connosco no WhatsApp

Constróis para uma instituição? Vê a página para instituições.