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 é um software livre e de código aberto para assinaturas eletrônicas no Nextcloud. Sua API REST, baseada no protocolo OCS do Nextcloud, permite que sistemas externos solicitem assinaturas, acompanhem o andamento e validem documentos. Uma aplicação existente pode manter sua própria interface e seus fluxos de trabalho enquanto seu backend se comunica com o LibreSign. A API está incluída no software; não é necessário pagar separadamente pelo acesso à API. Hospedagem, serviços de integração e suporte 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 acesse Manual do desenvolvedor e API. Você encontrará guias de integração, exemplos práticos, a referência OpenAPI interativa e o respectivo contrato JSON para download. Os guias abordam solicitações de assinatura, convites, consultas de status e recuperação autorizada de documentos assinados.
Utilize a documentação correspondente à versão instalada: os recursos disponíveis e os campos das requisições podem mudar ao longo do tempo. A documentação da versão de desenvolvimento pode descrever funcionalidades que ainda não fazem parte de uma versão estável.
Autenticação e integração com sistemas externos
Para integrar sistemas de servidor para servidor, use HTTPS e uma conta autorizada do Nextcloud com uma senha de aplicativo revogável (App Password). As requisições OCS normalmente usam autenticação HTTP Basic e o cabeçalho OCS-APIRequest: true. Mantenha as credenciais no backend, nunca no código executado no cliente. O uso de tokens Bearer depende da configuração de autenticação da sua instância Nextcloud; entrar em outro aplicativo não concede automaticamente acesso à API.
Seu backend pode criar solicitações de assinatura e acompanhar seu status pelos endpoints documentados. Dependendo das configurações habilitadas no LibreSign, os destinatários podem assinar com suas contas Nextcloud ou por meio de convites individuais, sem precisar criar uma conta Nextcloud. Uma conta de integração não deve ser usada para se passar pelos signatários.
A inspeção pelo navegador é uma ferramenta de diagnóstico
A aba Rede (Network) das ferramentas de desenvolvedor do navegador (F12) e o OCS API Viewer podem ajudar a investigar requisições e respostas de uma instalação específica. São ferramentas complementares para diagnóstico, não substituem o contrato OpenAPI oficial: as chamadas feitas 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, links de assinatura ou conteúdo dos documentos durante a depuração.