SOFTIC Academy

API e chaves de API

Atualizado em 06/11/2026

A API Softic.Invoice permite a um ERP ou software de faturação enviar as suas faturas, pedir o seu processamento, ler o estado legal e obter os documentos. Está descrita em OpenAPI em /services/swagger e no guia de integração.

Chaves de API

Faturação > Chaves de API (administradores): uma chave por sistema chamador. Na criação, a chave completa é mostrada uma única vez: copie-a, só a sua impressão digital é guardada. Uma chave pode limitar-se à criação de rascunhos e leitura, ou ser autorizada a processar (emitir, assinar, submeter, anular). Pode expirar, ser desativada ou apagada; a última utilização é visível.

O que faz a API

  • POST /api/v1/invoices: cria ou atualiza rascunhos em JSON (o mesmo formato da importação), idempotente por referência externa, com processamento imediato opcional.
  • Leitura por identificador, por referência externa ou das alterações desde uma data (consulta periódica pelo ERP).
  • Ações: emitir, assinar, submeter, processar numa só chamada, consultar a plataforma, anular.
  • Documentos legais (XML assinado, resposta da plataforma, elemento SAF-T) e fatura imprimível na língua pretendida.
  • Referencial da empresa: regime, códigos de impostos, clientes, artigos.

As faturas criadas pela API aparecem no ecrã Faturas com, no seu histórico, o nome da chave que agiu.

Palavras-chave api cle x-api-key rest json integration statut documents swagger