Přeskočit na hlavní obsah

Průvodce API LibreSign

10. říj 2024

LibreSign API: Integrace s ostatními systémy

Aktualizováno 10. listopadu 2026. Původně zveřejněno 10. října 2024.

LibreSign je svobodný software s otevřeným zdrojovým kódem pro elektronické podpisy na Nextcloudu. Jeho REST API, založené na protokolu OCS Nextcloudu, umožňuje externímu systému požadovat podpisy, sledovat pokrok a ověřovat dokumenty. Stávající aplikace si může udržet své vlastní rozhraní a pracovní toky, zatímco její backend komunikuje s LibreSign. API je součástí softwaru; nemusíte si kupovat samostatný přístup API. Hosting, integrační služby a podpora jsou nepovinné.

Oficiální integrační dokumentace

Začněte u úřední dokumentace LibreSign. Vyberte LibreSign vydání nainstalované na serveru Nextcloud, poté otevřete Vývojářský manuál a API. Najdete integrační průvodce, praktické příklady, interaktivní OpenAPI odkaz a jeho stažitelnou smlouvu JSON. Průvodce se vztahuje na požadavky na podpis, pozvánky, kontroly stavu a autorizované vyhledávání podepsaných dokumentů.

Použijte dokumentaci pro nainstalované vydání: dostupné funkce a pole žádosti se mohou měnit v průběhu času. Vývojová dokumentace může popisovat funkčnost, která ještě není zahrnuta ve stabilním vydání.

Autentizace a integrace s externími systémy

Pro integraci server- to- serveru použijte HTTPS a autorizovaný účet Nextcloud s Odvolatelné heslo aplikace. OCS požadavky obvykle používat HTTP Základní autentizace a OCS-APIRequest: true hlavička. Uchovejte si na svém backendu, nikdy v klientském bočním kódu. Závislí na autentizační konfiguraci instance Nextcloud; přihlášení k jiné aplikaci automaticky neposkytuje API přístup.

Váš backend může vytvořit podpisové požadavky a sledovat jejich stav pomocí zdokumentovaných koncových bodů. V závislosti na nastaveních povolených v LibreSign se mohou příjemci podepsat svými účty Nextcloud nebo prostřednictvím jednotlivých pozvánek, aniž by vytvořili účet Nextcloud. Integrační účet nesmí být použit k napodobování signalizátorů.

Kontrola prohlížeče je diagnostický nástroj

Záložka Síť prohlížeče (F12) a Prohlížeč OCS API mohou pomoci při zkoumání požadavků a odpovědí na konkrétní zařízení. Jedná se o doplňující nástroje pro řešení problémů, není náhradou za oficiální smlouvu OpenAPI: prohlížeč hovory mohou záviset na session cookies nebo interface- specifické chování. Použijte verze průvodce a příklady první, a vyhnout se odhalení pověřovací listiny, podepisování odkazy, nebo obsah dokumentu při ladění.