Quickstart

Faz a tua primeira chamada à API Uwata em menos de 5 minutos.

Actualizado em Abril 2026

1. Cria a tua API Key

Acede ao teu Dashboard em uwata.app/dashboard/programadores e clica em Nova API Key. Escolhe um nome descritivo (ex: "ERP Interno"), selecciona o modo Teste para desenvolvimento e os scopes necessários.

O token completo é mostrado uma única vez após a criação. Guarda-o num gestor de segredos como o AWS Secrets Manager, Vault, ou variáveis de ambiente. Nunca o incluas directamente no código fonte.

2. Faz a tua primeira chamada

Todos os pedidos à API pública requerem dois cabeçalhos:

  • Authorization: Bearer <token> — a tua API Key
  • X-Company-Id: <companyId> — o ID da empresa (visível no URL do Dashboard)
GET/api/v1/v1/invoicesListar facturas
Listar facturas
curl -X GET https://api.uwata.app/api/v1/v1/invoices \
  -H "Authorization: Bearer sk_live_SEU_TOKEN_AQUI" \
  -H "X-Company-Id: SEU_COMPANY_ID"

3. Interpreta a resposta

A API devolve sempre JSON com a estrutura data (array de resultados),total, page e pageSize para endpoints de listagem.

Resposta exemplo
{
  "data": [
    {
      "id": "clx1234abcd",
      "number": "FT 2024/1",
      "type": "FT",
      "status": "ISSUED",
      "totalAmount": 150000,
      "currency": "AOA",
      "issuedAt": "2024-11-01T10:00:00.000Z",
      "customer": {
        "id": "cly5678efgh",
        "name": "Empresa ABC, Lda.",
        "nif": "5000123456"
      }
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 20
}

4. Trata os erros

Quando algo corre mal, a API devolve um código HTTP adequado e um corpo JSON comstatusCode, message e error. Consulta o guia de Erros & Limites para a lista completa.

Erro de autenticação
{
  "statusCode": 401,
  "message": "API Key inválida ou revogada.",
  "error": "Unauthorized"
}

Próximos passos