APIs da plataforma

Cada serviço da plataforma expõe a sua própria API REST e está documentado na secção do seu domínio. Num workspace, todos são alcançados através do gateway, em http://<slug>:2575/gateway-api/<nome-eureka>.

O <nome-eureka> é o nome com que o serviço se regista no Eureka (em produção, o ingress do Kubernetes faz o mesmo papel — ver Cloud & Deploy).

AutenticaçãoCopy Anchor Link

Os tokens são JWT emitidos pelo Access Management, que federa o fornecedor de identidade real (Autentika, Keycloak ou WSO2). Cada pedido leva:

Authorization: Bearer <token>

• Utilizadores — o token da sessão da app (NextAuth com o fornecedor igrp-auth).
• Serviços — token client_credentials do Access Management; ver API M2M e SDK Java.

ConvençõesCopy Anchor Link

• Corpo e respostas em application/json.
• Listas paginadas com page/size (ou pageNumber/pageSize no Process Studio) e resposta com content, totalElements, totalPages.
• Identificadores de recursos são UUID (instâncias, tarefas, projetos, processos).
• Erros de validação seguem problem details: status, title, errors (campo → mensagem) e instance. Outros erros usam o corpo por defeito do Spring: timestamp, status, error, path.
• Cada serviço publica a sua especificação OpenAPI (springdoc), que é a referência exata de cada versão.