முதன்மை உள்ளடக்கத்திற்குச் செல்லவும்

LibreSign API வழிகாட்டி

Vitor Mattos மூலம் Vitor Mattos

10 அக்டோபர் 2024

LibreSign API: பிற அமைப்புகளுடன் ஒருங்கிணைத்தல்

2026 நவம்பர் 10 அன்று புதுப்பிக்கப்பட்டது. முதலில் 2024 அக்டோபர் 10 அன்று வெளியிடப்பட்டது.

LibreSign என்பது Nextcloud-இல் மின்னணு கையொப்பமிடலுக்கான கட்டற்ற, திறந்த மூல மென்பொருளாகும். Nextcloud-இன் OCS நெறிமுறையை அடிப்படையாகக் கொண்ட அதன் REST API மூலம் வெளிப்புற அமைப்புகள் கையொப்பங்களைக் கோரவும், முன்னேற்றத்தைக் கண்காணிக்கவும், ஆவணங்களைச் சரிபார்க்கவும் முடியும். ஏற்கெனவே உள்ள ஒரு பயன்பாடு தனது இடைமுகத்தையும் செயலோட்டங்களையும் தொடர்ந்து பயன்படுத்திக்கொண்டே, அதன் பின்புறச் சேவையிலிருந்து LibreSign-உடன் தொடர்புகொள்ளலாம். API மென்பொருளிலேயே அடங்கியுள்ளது; அதைப் பயன்படுத்துவதற்குத் தனியாகக் கட்டணம் செலுத்தத் தேவையில்லை. ஹோஸ்டிங், ஒருங்கிணைப்புச் சேவைகள் மற்றும் ஆதரவு ஆகியவை விருப்பத்திற்குரியவை.

அதிகாரப்பூர்வ ஒருங்கிணைப்பு ஆவணங்கள்

முதலில் LibreSign-இன் அதிகாரப்பூர்வ ஆவணங்களை அணுகுங்கள். உங்கள் Nextcloud சேவையகத்தில் நிறுவப்பட்டுள்ள LibreSign பதிப்பைத் தேர்ந்தெடுத்து, Developer manual and API பகுதியைத் திறக்கவும். ஒருங்கிணைப்பு வழிகாட்டிகள், நடைமுறை எடுத்துக்காட்டுகள், பயனுடன் சோதிக்கக்கூடிய OpenAPI குறிப்புகள் மற்றும் பதிவிறக்கக்கூடிய JSON ஒப்பந்தம் ஆகியவை அங்கு கிடைக்கும். கையொப்பக் கோரிக்கைகள், அழைப்புகள், நிலைச் சரிபார்ப்புகள் மற்றும் அனுமதிக்கப்பட்ட முறையில் கையொப்பமிட்ட ஆவணங்களை மீட்டெடுத்தல் ஆகியவற்றை வழிகாட்டிகள் விளக்குகின்றன.

நீங்கள் நிறுவியுள்ள பதிப்புக்குரிய ஆவணங்களையே பயன்படுத்துங்கள். கிடைக்கக்கூடிய அம்சங்களும் கோரிக்கைப் புலங்களும் காலப்போக்கில் மாறலாம். மேம்பாட்டு பதிப்புக்கான ஆவணங்களில் இன்னும் நிலையான வெளியீட்டில் சேராத அம்சங்கள் இருக்கக்கூடும்.

வெளிப்புற அமைப்புகளுடனான அங்கீகாரமும் ஒருங்கிணைப்பும்

சேவையகங்களுக்கு இடையிலான ஒருங்கிணைப்புக்கு HTTPS-ஐயும், உரிய அனுமதியுள்ள Nextcloud கணக்கின் திரும்பப்பெறக்கூடிய பயன்பாட்டுக் கடவுச்சொல்லையும் (App Password) பயன்படுத்துங்கள். OCS கோரிக்கைகளில் பொதுவாக HTTP Basic அங்கீகாரமும் OCS-APIRequest: true என்ற தலைப்பும் பயன்படுத்தப்படுகின்றன. அணுகல் விவரங்களை உங்கள் பின்புறச் சேவையில் பாதுகாப்பாக வைத்திருக்கவும்; வாடிக்கையாளர் பக்கக் குறியீட்டில் ஒருபோதும் சேர்க்க வேண்டாம். Bearer டோக்கன்களின் பயன்பாடு உங்கள் Nextcloud நிறுவலின் அங்கீகார உள்ளமைப்பைப் பொறுத்தது. வேறொரு பயன்பாட்டில் உள்நுழைவதால் LibreSign API-க்கான அனுமதி தானாகக் கிடைக்காது.

ஆவணப்படுத்தப்பட்ட முடிவுப்புள்ளிகளின் வழியாக உங்கள் பின்புறச் சேவை கையொப்பக் கோரிக்கைகளை உருவாக்கி அவற்றின் நிலையைக் கண்காணிக்கலாம். LibreSign-இல் இயக்கப்பட்டுள்ள அமைப்புகளைப் பொறுத்து, பெறுநர்கள் தங்கள் Nextcloud கணக்குகளால் அல்லது Nextcloud கணக்கை உருவாக்காமல் தனிப்பட்ட அழைப்புகளின் மூலம் கையொப்பமிடலாம். ஒருங்கிணைப்புக் கணக்கைப் பயன்படுத்தி கையொப்பமிடுபவர்களாக ஆள்மாறாட்டம் செய்யக் கூடாது.

உலாவி ஆய்வு என்பது கோளாறு கண்டறியும் கருவி

உலாவியின் Network தாவல் (F12) மற்றும் OCS API Viewer ஆகியவை குறிப்பிட்ட நிறுவலில் உள்ள கோரிக்கைகளையும் பதில்களையும் ஆராய உதவும். அவை ஒன்றுக்கொன்று துணைபுரியும் கோளாறு கண்டறியும் கருவிகள் மட்டுமே; அதிகாரப்பூர்வ OpenAPI ஒப்பந்தத்திற்கு மாற்றாகாது. உலாவியில் உருவாகும் கோரிக்கைகள் அமர்வுக் குக்கீகள் அல்லது குறிப்பிட்ட இடைமுகத்தின் நடத்தையைச் சார்ந்திருக்கலாம். முதலில் பதிப்பிற்கேற்ற வழிகாட்டிகளையும் எடுத்துக்காட்டுகளையும் பயன்படுத்துங்கள். பிழைகளை ஆய்வு செய்யும்போது அணுகல் விவரங்கள், கையொப்பமிடும் இணைப்புகள் அல்லது ஆவண உள்ளடக்கங்களை வெளிப்படுத்த வேண்டாம்.