Paliwanag sa Sakop ng Interface ng Aplikasyon sa Ekosistema ng ISV

1. Buod

Ang dokumentong ito ay layuning magbigay ng paliwanag sa Scope (domain ng permiso) sa sistema ng pagpapatunay ng aplikasyon ng eSignGlobal para sa mga developer ng mga partner sa ekosistema. Kapag nag-uugnay ang mga developer sa pagpapatunay ng aplikasyon, kailangan nilang humingi ng angkop na Scope base sa aktwal na pangangailangan ng negosyo. Bawat Scope ay naglalaman ng listahan ng mga OpenAPI na pinapayagang tawagin sa ilalim ng domain ng permiso na iyon, at mahigpit na kontrolin ng plataporma ang mga permiso ng aplikasyon sa paggamit ng mga kaugnay na mapagkukunan batay sa awtorisadong Scope.

Pangunahing Interface ng Pagpapatunay

Bago pormal na tumawag ng interface ang mga aplikasyon sa ekosistema, kailangan munang kumuha ng credentials para sa pag-access sa pamamagitan ng authorization endpoint:

Pangalan ng Interface	Landas ng Interface	Paglalarawan ng Interface
Kumuha ng AccessToken	`POST /esignglobal/v1/oauth2/accessToken`	Sa pamamagitan ng appid at appsecret upang makakuha ng access_token para sa pagpapatunay, na ginagamit upang mag-request ng eSignGlobal API bilang partikular na user, at ang tagal ng pagkabisa ng Token ay 24 na oras.

Kasalukuyan, ang mga Scope domain ng permiso na bukas sa ekosistema ng eSignGlobal ay pangunahing kinabibilangan ng:

signature：Pangunahing Serbisyo ng Elektronikong Pirma
stamp：Serbisyo ng Pamamahala ng Selyo
comparisons：Serbisyo ng Paghahambing ng Kontrata

2. Detalye ng Scope at Listahan ng mga Interface

2.1 Scope: `signature` (Serbisyo ng Elektronikong Pirma)

Ang Scope na ito ay ang pinakapundamental at karaniwang ginagamit na saklaw ng pahintulot, na naglalaman ng mga pangunahing interface sa buong proseso para sa serbisyo ng elektronikoong pirma. Kapag binigyan ng awtorisasyon ang Scope na ito, maaaring pamahalaan at i-manage ng aplikasyon ang mga template, mga dokumentong ipinirmahan (kasama ang mga attachment), mga kalahok, at ang pangunahing daloy ng envelope.

Modulo Uno: Serbisyo ng Template

Pangalan ng Interface	Paglalarawan ng Interface
Kumuha ng detalye ng mga kontrol ng template ng tagapirmahan	Kumuha ng impormasyon ng mga kontrol ng template para sa tinukoy na tagapirmahan at ang kanyang kaugnay na konfigurasyon ng katangian
Kumuha ng detalye ng template	Kumuha ng kumpletong impormasyon para sa tiyak na template, kasama ang mga detalye ng mga field at istruktura ng file
Punan ang template upang makabuo ng file	Ayon sa ibinigay na template, punan ang datos ng negosyo at awtomatikong i-combine upang makabuo ng file sa format na PDF
Maghanap ng listahan ng mga template	Maghanap ng listahan ng mga available na template sa ilalim ng kasalukuyang account gamit ang pagination o base sa partikular na mga kondisyon ng pag-filter
Maghanap ng detalye ng task sa pagbuo ng file	I-query ang huling resulta ng pagpapatupad ng gawain sa paglikha ng file mula sa template gamit ang asynchronous task ID

Modulo 2: Pamamahala ng File

Pangalan ng interface	Paglalarawan ng interface
Mag-upload ng File	I-upload ang tinukoy na lokal na file o file ng daloy ng negosyo sa platform para sa susunod na pagpirma
Kumuha ng koordinado batay sa mga keyword	Maghanap ng teksto sa mga na-upload na dokumento at ibalik ang koordinado ng mga tumutugmang keyword
Mag-download ng File	I-download ang partikular na nakompletong pirmadong dokumento, pinagmulang file, o iba pang attachment na file ng negosyo
Magdagdag ng File sa Pagpirma	I-bind ang mga naunang matagumpay na na-upload na file sa tiyak na envelope o proseso ng pagpirma
Tanggalin ang File sa Pagpirma	Alisin ang mga maling na-upload o pansamantalang hindi kailangan na file sa pagpirma mula sa proseso ng envelope
Magdagdag ng Attachment	Magdagdag ng karagdagang attachment na naglalaman ng paliwanag sa envelope o proseso ng pagpirma.
Burahin ang attachment.	Alisin ang tinukoy na attachment document mula sa envelope o proseso ng pagpirma.

Modulo 3: Pamamahala ng mga Partikipe

Pangalan ng Interface	Paglalarawan ng Interface
Magdagdag ng Tagapirmahan	Magdagdag ng partikipe na tagapirmahan na kailangang magpatupad ng aksyon ng pagpirma sa tiyak na proseso ng envelope.
Burahin ang Tagapirmahan	Alisin ang hindi na aktibong tagapirmahan sa tiyak na proseso ng envelope.
Magdagdag ng CC Recipient	Magdagdag ng rol ng CC, tumatanggap lamang ng abiso tungkol sa progreso at nakakakita ng huling natapos na dokumento na may pirma.
Burahin ang CC Recipient	Alisin ang tiyak na rol ng CC

Modulo 4: Pamamahala ng Envelope

Pangalan ng Interface	Deskripsyon ng Interface
Mabilis na Magpasimula ng Envelope	Kung gagamitin ng platform ang interface na ito upang lumikha ng envelope, at matapos ang pagpirma, awtomatikong hahandlein ng sistema ang proseso ng pagtatapos, kaya hindi na kailangan ng manu-manong tawag sa "Tapusin ang Envelope".
Lumikha ng Envelope	Ginagamit upang lumikha ng envelope na nasa draft na estado, sumusuporta sa pagkaka-configure ng paksa ng pagpirma, mga setting ng nagpirmahan, at iba pang parameter.
Buksan ang Envelope	Kapag nakumpirma na tama ang lahat ng dokumento ng pagpirma at mga nagpirmahan, opisyal na ipapadala sa downstream ang gawain ng pagpirma.
Tapusin ang Envelope	Manu-manong pagtatapos ng envelope. Bago matapos ang envelope, kailangang tapusin ng lahat ng nagpirmahan ang kanilang pagpirma; hindi na mababago ang mga resource pagkatapos matapos ang proseso.
Kunin ang Address ng Pagpirma	Kunin ang eksklusibong maikling link o direktang maaring i-load na URL ng pahina ng pagpirma para sa tinukoy na nagpirmahan.
Suriin ang mga Detalye ng Envelope	Kunin ang kabuuang impormasyon ng envelope, mga kaugnay na file, mga kalahok, at kasalukuyang estado ng daloy.
Kanselahin ang Envelope	I-revoke ng tagapagsimula ang isang envelope ng pagpirmâ na hindi pa kumpleto
Paalala sa Envelope	Kapag hindi pa kumpleto ang pagpirmâ ng envelope, sumusuporta sa pagpapadala ng paalala sa mga signer na kailangan pang mag-pirmâ pero hindi pa, na may interval ng paalala na 30 minuto.
Kumuha ng address ng pahina ng preview ng pagpirmâ	Pagkatapos buksan ang envelope, maaaring kumuha ng address ng pahina ng preview ng pagpirmâ gamit ang API na ito. Pangunahing ginagamit sa loob ng integrated platform upang payagan ang mga hindi kalahok sa envelope na makakita ng mga dokumento at progreso ng pagpirmâ.
Lumikha ng view ng pagpapadala ng envelope	Lumikha ng view ng tagapagpadala ng envelope gamit ang envelope ID. Sa mga proseso ng pagpirmâ na isinasimula sa ilalim ng view na ito, ang impormasyon ng tagapagsimula ay pupunan ng impormasyon ng gumagamit na nire-resolve mula sa Access Token sa OAuth.

2.2 Scope: `stamp` (Serbisyo sa Pamamahala ng Selyo)

Ang Scope na ito ay espesyal na para sa awtorisasyon sa pamamahala ng selyo ng kumpanya o personal na pangalan. Angkop ito para sa mga third-party ecosystem na nangangailangan lamang ng pagpapanatili ng pagsama-samang selyo ng kumpanya (pagdaragdag, pagbura, pagbabago, at paghahanap ng mga selyo), nang hindi direktang nakikiintervento sa proseso ng pagsimula ng pagpirmâ.

Pangalan ng API	Deskripsyon ng API
Mag-query ng listahan ng mga selyo	Gamitin ang AppID na may katumbas na permiso sa pag-query ng selyo upang makuha ang datos ng listahan ng mga resource ng selyo.
Lumikha ng selyo	Gamitin ang pinayagang AppID upang lumikha ng selyo sa pamamagitan ng Base64 encoded string ng na-upload na imahe (sumusuporta sa PNG, sukat 18mm-100mm).
I-edit ang Tatak	Baguhin ang mga impormasyon tulad ng pangalan at larawan ng isang nilikhang tatak
Burahin ang Tatak	Ganap na alisin ang mga tinukoy na resorsyong tatak na wala nang kaugnayan sa negosyo

2.3 Scope: `comparisons` (Serbisyo sa Paghahambing ng Kontrata)

Ang Scope na ito ay eksklusibo para sa dominyo ng legal na tampok ng matalinong kontrata. Binibigyan-daan nito ang mga aplikasyon ng mga kasosyong partner na malayang gamitin ang kakayahang maghambing ng teksto at bersyon sa kanilang sariling proseso ng pagsusuri ng kontrata at legal na pagtatasa, upang mabilis na matukoy ang mga pagkakaiba bago at pagkatapos ng pagrevise ng kontrata.

Pangalan ng Interface	Paglalarawan ng Interface
Makuha ang pahina ng resulta ng paghahambing ng kontrata	Makuha ang address ng visual na pahina na nagpapakita ng resulta ng pagkakaiba sa paghahambing
Mag-query ng mga detalye ng paghahambing ng kontrata	Kunin ang resulta ng paghahambing ng kontrata gamit ang Business ID ng paghahambing ng kontrata, kabilang ang bilang ng mga pagkakaiba (bilang ng dagdag, burado, at pagbabago) at detalyadong nilalaman ng pagkakaiba sa paghahambing (pinpoint ng detalye)