Ir para o conteúdo principal

Guia da API do LibreSign

10 de out de 2024

API do LibreSign: integração com outros sistemas

Atualizado em 10 de novembro de 2026. Publicado originalmente em 10 de outubro de 2024.

O LibreSign é software livre e de código aberto para assinaturas eletrónicas no Nextcloud. A sua API REST, baseada no protocolo OCS do Nextcloud, permite que sistemas externos peçam assinaturas, acompanhem o progresso e validem documentos. Uma aplicação existente pode manter a sua própria interface e os seus fluxos de trabalho, enquanto o respetivo backend comunica com o LibreSign. A API está incluída no software: não é necessário pagar pelo acesso à API. O alojamento gerido, os serviços de integração e o apoio técnico são opcionais.

Documentação oficial de integração

Comece pela documentação oficial do LibreSign. Selecione a versão do LibreSign instalada no seu servidor Nextcloud e abra Manual do programador e API. Encontrará guias de integração, exemplos práticos, a referência OpenAPI interativa e o respetivo contrato JSON para descarregar. Os guias abrangem pedidos de assinatura, convites, consultas de estado e obtenção autorizada dos documentos assinados.

Consulte a documentação da versão que tem instalada: as funcionalidades e os campos dos pedidos podem mudar entre versões. A documentação de desenvolvimento pode descrever funcionalidades ainda não disponíveis numa versão estável.

Autenticação e integração com sistemas externos

Para integrações entre servidores, utilize HTTPS e uma conta Nextcloud autorizada, com uma palavra-passe de aplicação revogável (App Password). Os pedidos OCS utilizam normalmente autenticação HTTP Basic e o cabeçalho OCS-APIRequest: true. Guarde as credenciais no backend, nunca em código executado pelo cliente. A utilização de tokens Bearer depende da configuração de autenticação da instância Nextcloud; iniciar sessão noutra aplicação não concede automaticamente acesso à API.

O seu backend pode criar pedidos de assinatura e acompanhar o respetivo estado através dos endpoints documentados. Consoante as definições do LibreSign, os destinatários podem assinar com as suas contas Nextcloud ou através de convites individuais, sem criarem uma conta Nextcloud. Uma conta de integração não deve ser usada para se fazer passar pelos signatários.

A inspeção do navegador é uma ferramenta de diagnóstico

O separador Rede (Network) das ferramentas de programador do navegador (F12) e o OCS API Viewer podem ajudar a analisar pedidos e respostas numa instalação específica. São ferramentas de diagnóstico complementares, não substituem o contrato OpenAPI oficial: os pedidos feitos pelo navegador podem depender de cookies de sessão ou de comportamentos específicos da interface. Consulte primeiro os guias e exemplos versionados e evite expor credenciais, ligações de assinatura ou o conteúdo dos documentos durante a depuração.