Atura
Atura

API Atura

Quickstart

v1.0

Começa a usar a API Atura em poucos minutos. Esta guia vai ajudar-te a fazer a primeira chamada à API.

Documentação em Desenvolvimento

Esta documentação está ainda em desenvolvimento ativo. Algumas secções podem estar incompletas ou sujeitas a alterações. Para questões específicas, contacta o nosso suporte técnico.

O que é a API Atura?

A API Atura permite-te integrar facilmente funcionalidades de faturação portuguesa na tua aplicação. Com suporte completo para SAF-T, assinaturas digitais, e cálculos fiscais automáticos.

Conforme AT

Totalmente compatível com as normas da Autoridade Tributária

REST API

Interface simples e intuitiva baseada em HTTP

JSON

Todas as respostas em formato JSON estruturado

Autenticação

A API Atura usa chaves de API para autenticação. Podes obter a tua chave no painel de administração.

1. Obter a chave de API

Acede ao teu painel e vai para a secção "API Keys" para gerar uma nova chave.

Importante: Guarda a tua chave de API em segurança e nunca a partilhes publicamente.

2. Incluir no cabeçalho

Todas as chamadas à API devem incluir o cabeçalho de autorização:

Bash
Authorization: Bearer sua_chave_api_aqui

Primeira Chamada à API

POST/v1/documents/drafts

Vamos criar um rascunho de fatura para testares a integração. Este é o endpoint mais comum para começar.

Exemplos em Diferentes Linguagens

curl -X POST https://api.atura.pt/v1/documents/drafts \
  -H "Authorization: Bearer sua_chave_api_aqui" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "invoice",
    "customer": {
      "name": "Cliente Exemplo",
      "email": "cliente@exemplo.com",
      "tax_id": "123456789"
    },
    "items": [
      {
        "description": "Produto de teste",
        "quantity": 1,
        "unit_price": 10.00,
        "tax_rate": 23
      }
    ]
  }'

Exemplo de Pedido

JSON
POST /v1/documents/drafts
Authorization: Bearer sua_chave_api_aqui
Content-Type: application/json

{
  "type": "invoice",
  "customer": {
    "name": "Cliente Exemplo",
    "email": "cliente@exemplo.com",
    "tax_id": "123456789"
  },
  "items": [
    {
      "description": "Produto de teste",
      "quantity": 1,
      "unit_price": 10.00,
      "tax_rate": 23
    }
  ]
}

Resposta

JSON
{
  "id": "draft_1234567890",
  "type": "invoice",
  "status": "draft",
  "customer": {
    "id": "cust_9876543210",
    "name": "Cliente Exemplo",
    "email": "cliente@exemplo.com",
    "tax_id": "123456789"
  },
  "items": [
    {
      "id": "item_1111111111",
      "description": "Produto de teste",
      "quantity": 1,
      "unit_price": 10.00,
      "tax_rate": 23,
      "tax_amount": 2.30,
      "total": 12.30
    }
  ],
  "subtotal": 10.00,
  "tax_total": 2.30,
  "total": 12.30,
  "currency": "EUR",
  "created_at": "2025-01-15T10:30:00Z",
  "updated_at": "2025-01-15T10:30:00Z"
}

Próximos Passos

Explorar a API

Recursos Úteis