Megjelölés megjelölése (előzetes verzió)
A Mark Sign az eIDAS-szabályozásnak megfelelő minősített elektronikus aláírási szolgáltatás. Dokumentumokat küldhet aláírásra, megvárja az aláírásokat, letöltheti és érvényesítheti az aláírt fájlokat.
Ez az összekötő a következő termékekben és régiókban érhető el:
| Service | osztály | Regions |
|---|---|---|
| Copilot Studio | prémium | Az összes Power Automate-régió, kivéve a következőket: - USA kormánya (GCC) - Amerikai kormány (GCC High) - A 21Vianet által üzemeltetett China Cloud - Amerikai Védelmi Minisztérium (DoD) |
| Logikai alkalmazások | Standard | Az összes Logic Apps-régió , kivéve a következőket: - Azure Government-régiók - Azure China-régiók - Amerikai Védelmi Minisztérium (DoD) |
| Power Apps | prémium | Az összes Power Apps-régió , kivéve a következőket: - USA kormánya (GCC) - Amerikai kormány (GCC High) - A 21Vianet által üzemeltetett China Cloud - Amerikai Védelmi Minisztérium (DoD) |
| Power Automate | prémium | Az összes Power Automate-régió, kivéve a következőket: - USA kormánya (GCC) - Amerikai kormány (GCC High) - A 21Vianet által üzemeltetett China Cloud - Amerikai Védelmi Minisztérium (DoD) |
| Contact | |
|---|---|
| Name | Megjelölés azonosítója, UAB |
| URL | https://marksign.eu |
| pagalba@marksign.lt |
| Összekötő metaadatai | |
|---|---|
| Publisher | Megjelölés azonosítója, UAB |
| Webhely | https://marksign.eu |
| Adatvédelmi irányelvek | https://marksign.eu/privacy-policy |
| Categories | Termelékenység; Tartalom és fájlok |
Megjelölés megjelölése
A Mark Sign az eIDAS-rendeletnek megfelelő minősített elektronikus aláírási szolgáltatás. A folyamatok elküldhetnek egy dokumentumot aláírásra, megvárhatják, amíg aláírják, majd letöltik az aláírt fájlt, és érvényesítik azt.
Publisher: Mark ID, UAB
Prerequisites
Mark Sign API hozzáférési jogkivonatra van szüksége. Lásd alább a hitelesítő adatok beszerzését.
Támogatott műveletek
Dokumentum: Feltöltés
Feltölt egy dokumentumot (PDF, ADoc, BDoc vagy ASiC-E) és előkészíti az aláírásra. A fájlnév lesz a dokumentum címe.
Aláírás: Meghívás e-mailben
Meghív egy személyt az aláírásra; Mark Sign elküldi a meghívó e-mailt. Ugyanazon személy ismételt meghívása emlékeztetőt küld.
Aláírás: Meghívás URL-cím alapján
E-mail küldése nélkül hozzáad egy aláírót, és visszaadja a személyes meghívó URL-címét , hogy ön kézbesítse.
Aláírás: Várja meg az összes aláírót
A folyamatot a dokumentum aláírásáig vagy elutasításáig, illetve a timed_out várakozási idő (alapértelmezés szerint 29 nap) lejártakor végződik.
Aláírás: Várjon egy aláíróra
A folyamatot addig tartja, amíg egy adott aláíró, e-mailben kiválasztva nem jelentkezik. Az elutasítás is véget vet a várakozásnak.
Aláírás: Várja meg a következő aláírót
Folytatja a folyamatot abban a pillanatban, amikor a következő aláíró aláírja vagy elutasítja, lekérdezés nélkül.
Dokumentum: Állapot lekérése
Ellenőrzi a dokumentum általános aláírási állapotát.
Dokumentum: Aláírók lekérése
Felsorolja az egyes aláírók állapotát, beleértve az elutasítás okát is, ha egy aláíró elutasított.
Dokumentum: Letöltés
Letölti a dokumentumot az eddig összegyűjtött összes aláírással.
Dokumentum: Lista
A munkaterületen található dokumentumokat szöveges kereséssel és lapozással listázza.
Dokumentum: Eltávolítás
Eltávolít egy dokumentumot a munkaterületről.
Dokumentum: Feltöltés tárolóként
Több fájlt egyesít egy aláírható tárolódokumentumba (ADoc, BDoc vagy ASiC-E). A számlázás az alapértelmezett megjelölést követi, ahol az egyes aláírók fizetnek.
Aláírás: Aláírói hivatkozások létrehozása
Létrehoz egy személyes aláírási hivatkozást az egyes aláírók számára, hogy kézbesítse magát. A hivatkozások lejárnak, identitás-ellenőrzést igényelhetnek, és az egyetlen elutasító beállítással rendelkező aláíró oldalak.
Aláírás: Megosztott hivatkozás létrehozása
Létrehoz egy hivatkozást, amelyet bárki megnyithat a dokumentumok aláírásához, mindegyik a saját ellenőrzött identitása alatt található.
Aláírás: Hivatkozás törlése
A lejárat előtt törli az aláíró hivatkozást vagy a megosztott hivatkozást.
Dokumentum: Aláírás érvényességének meghosszabbítása
Frissíti a dokumentum-aláírásokat a hosszú távú érvényesség (LT) vagy a hosszú távú archiválás (LTA) érdekében.
Dokumentum: Ellenőrzés
Ellenőrzi egy dokumentum aláírását, és visszaadja a teljes érvényesítési jelentést.
Hitelesítő adatok beszerzése
Lépjen kapcsolatba Mark Sign ügyfélszolgálatával pagalba@marksign.lt , hogy api-hozzáférési jogkivonatot kérjen a munkaterülethez. Amikor kapcsolatot hoz létre Power Automate, illessze be a jogkivonatot az "API Key" mezőbe.
A jogkivonat egy munkaterülethez van kötve, így a kapcsolaton keresztül létrehozott vagy felsorolt összes dokumentum az adott munkaterülethez tartozik.
Első lépések
A legegyszerűbb aláírási folyamat:
- Dokumentum: Feltöltés (például a fájltartalom és a név jogkivonatai SharePoint vagy OneDrive).
- Aláírás: Meghívás e-mailben. Mark Sign e-mailben a meghívót.
- Aláírás: Várja meg a következő aláírót. A folyamat itt szünetel, amíg az aláírás meg nem történik.
- Dokumentum: Töltse le és tárolja ott, ahol szüksége van rá.
Több aláíró esetén használja az Aláírás: Meghívás e-mailben minden személy számára, majd egy aláírás: Várja meg az összes aláíró lépését a letöltés előtt. Ha saját maga szeretné kézbesíteni a hivatkozásokat Mark Sign e-mailek helyett, használja az Aláírás: Meghívás URL-cím vagy aláírás alapján: Aláírói hivatkozások létrehozása és minden személy saját Outlook vagy Teams-művelettel való elküldése.
Ismert problémák és korlátozások
- Az összekötő nem biztosít folyamatindítókat; használja inkább a folyamaton belüli várakozási műveleteket.
- Egy dokumentum egy értesítési regisztrációval rendelkezik. Ne futtasson két aláírást: Várja meg a következő aláíró lépéseket ugyanazon a dokumentumon egyszerre. A második lecseréli az elsőt, az első lépés pedig megvárja, amíg túllépi az időkorlátot. A visszahívási URL-mező kitöltése bármely blokkban felülírja a regisztrációt is.
- Az aláírók csak aláíráskor utasíthatnak el egy dokumentumot : Aláíróhivatkozások létrehozása lapon (az Elutasítás megjelenítése gomb be van kapcsolva); Az e-mail-meghívók, a meghívó URL-címei és a megosztott hivatkozások nem kínálnak elutasítási lehetőséget.
- A Megjelölés csak az aláírásokról értesít. Ha egy meghívási blokk célja
reviewvagyconfirmationcélja van, az adott személy művelete soha nem ébreszti fel az aláírást: Várja meg a következő aláírót; ellenőrizze az állapotát a Dokumentum: Aláírók lekérése lehetőséggel. - Dokumentum: A letöltés csak a fájl tartalmát adja vissza; adja meg a fájl nevét a Dokumentum: Listából vagy a feltöltési lépésből.
- A folyamatfuttatás legfeljebb 30 napig (Power Automate korlátig) tarthat, így nincs várakozás.
Aláírás: Várja meg az összes aláírót és aláírást: Alapértelmezés szerint 29 nap után várjon egy aláírót az
timed_outállapottal. Aláíráshoz: Várja meg a következő aláírót, állítson be egy időtúllépést (példáulP29D) a művelet beállításai között, és adjon hozzá egy, a művelet túllépése után futtatásra konfigurált ágat. Ha a 30 napos futtatási korlát először eléri a korlátot, Power Automate megszakítja az egész futtatás, és egyetlen ág sem kezeli azt. - Dokumentum: A lista nem támogatja az állapot szerinti szűrést.
- Dokumentum: A feltöltés hívásonként egy fájlt fogad el; több feltöltéshez a mellékletek között. Dokumentum: A feltöltés tárolóként néhány fájlhoz készült; Ha egy hívásban több nagy fájlt kombinál, az túllépheti a feldolgozási időkorlátot.
Üzembe helyezési utasítások
Futtassa paconn create --api-prop apiProperties.json --api-def apiDefinition.swagger.json --script script.csx --icon icon.png az összekötő egyéni összekötőként való üzembe helyezését a Power Platform-környezetben. Részletekért tekintse meg a paconn dokumentációját .
Támogatás
Az összekötővel vagy a Mark Sign API-val kapcsolatos problémákért forduljon a következőhöz pagalba@marksign.lt: .
Kapcsolat létrehozása
Az összekötő a következő hitelesítési típusokat támogatja:
| Alapértelmezett | A kapcsolat létrehozásának paraméterei. | Minden régió | Nem osztható meg |
Alapértelmezett
Alkalmazható: Minden régió
A kapcsolat létrehozásának paraméterei.
Ez nem megosztható kapcsolat. Ha a power app meg van osztva egy másik felhasználóval, a rendszer kérni fogja, hogy hozzon létre új kapcsolatot.
| Name | Típus | Description | Required |
|---|---|---|---|
| API-kulcs | securestring | A munkaterület Mark Sign API hozzáférési jogkivonata. Kérjen egyet a Mark Sign támogatási szolgálatától: .> | True |
Műveletek
| Aláírás: Aláírói hivatkozások létrehozása |
Minden aláíróhoz létrehoz egy személyes aláírási hivatkozást. A hivatkozásokat saját maga kézbesítheti, például e-mailben vagy Teams-üzenetben. |
| Aláírás: Hivatkozás törlése |
A lejárat előtt törli az aláíró hivatkozást vagy a megosztott hivatkozást. A meghívóhivatkozások nem törölhetők. |
| Aláírás: Meghívás e-mailben |
Meghív egy személyt a dokumentum aláírására. Mark Sign e-mailben küldi el a meghívót. |
| Aláírás: Meghívás URL-cím alapján |
E-mail küldése nélkül hozzáad egy aláírót a dokumentumhoz, és visszaadja a személyes meghívó hivatkozását a kézbesítéshez. A hivatkozás nem jár le, és nem törölhető; Ha visszavonható hivatkozásokra van szüksége, használja az "Aláírás: Aláírói hivatkozások létrehozása" parancsot. |
| Aláírás: Megosztott hivatkozás létrehozása |
Létrehoz egy aláírási hivatkozást, amelyet bárki megnyithat a dokumentumok aláírásához. Saját maga kézbesíti. |
| Aláírás: Várja meg a következő aláírót |
Megvárja, amíg a következő aláíró aláírja vagy elutasítja a dokumentumot meghívók küldése nélkül. Használja egy ciklusban, hogy több aláírót várjon lekérdezés nélkül. |
| Aláírás: Várja meg az összes aláírót |
Megvárja, amíg minden aláíró aláírta vagy valaki elutasította a dokumentumot, majd engedélyezi a folyamat folytatását. A timed_out állapottal végződik, amikor az idő elfogy. |
| Aláírás: Várjon egy aláíróra |
Megvárja, amíg egy adott aláíró aláírja a dokumentumot, majd engedélyezi a folyamat folytatását. A timed_out állapottal végződik, amikor az idő elfogy. |
| Dokumentum: Aláírás érvényességének meghosszabbítása |
Frissíti a dokumentum aláírásait a hosszú távú érvényesség vagy archiválás érdekében. |
| Dokumentum: Aláírók lekérése |
Egy dokumentum aláíróinak listája az aláírási állapotukkal. |
| Dokumentum: Ellenőrzés |
Ellenőrzi egy dokumentum aláírását, és visszaadja az érvényesítési jelentést. A folyamat megvárja, amíg az ellenőrzés befejeződik. |
| Dokumentum: Eltávolítás |
Eltávolít egy dokumentumot a munkaterületről. |
| Dokumentum: Feltöltés |
Feltölt egy dokumentumot, és előkészíti az aláírásra. |
| Dokumentum: Feltöltés tárolóként |
Több fájlt egyesít egy aláírható tárolódokumentumban, például egy ADoc vagy ASiC-E fájlban. A fájlok feltöltése és kombinálása egyetlen lépésben. |
| Dokumentum: Letöltés |
Letölti a dokumentumot az eddig összegyűjtött összes aláírással. |
| Dokumentum: Lista |
Elsőként a munkaterületen található dokumentumokat sorolja fel. |
| Dokumentum: Állapot lekérése |
Lekéri egy dokumentum aláírási állapotát. |
Aláírás: Aláírói hivatkozások létrehozása
Minden aláíróhoz létrehoz egy személyes aláírási hivatkozást. A hivatkozásokat saját maga kézbesítheti, például e-mailben vagy Teams-üzenetben.
Paraméterek
| Név | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Dokumentumazonosítók
|
documents | True | array of string |
Az aláírási hivatkozásokat létrehozó dokumentumok. Használja a dokumentumazonosító-értékeket a feltöltési vagy listalépésekből. |
|
Aláíró azonosítója
|
id | string |
Az aláíró saját azonosítója, amely egyedi a kérelemben. Üres e-mail esetén kötelező megadni. |
|
|
Keresztnév
|
name | string |
Az aláíró utóneve. |
|
|
Vezetéknév
|
surname | string |
Az aláíró vezetékneve. |
|
|
Email
|
Az aláíró e-mail-címe. Kötelező, ha az aláíró azonosítója üres. |
|||
|
Személyes kód
|
personal_code | string |
Az aláíró személyes kódja. Szükség van a hitelesítésre. |
|
|
Hitelesítés megkövetelése
|
authentication_required | boolean |
Ha igen, az aláírónak ellenőriznie kell a személyazonosságát a hivatkozás megnyitása előtt. |
|
|
Pozíció (csak ADoc)
|
position | string |
Az aláíró beosztása az ADoc-aláírásokban látható. |
|
|
Részleg (csak ADoc)
|
structural_subdivision | string |
Az aláíró részlege, amely az ADoc-aláírásokban látható. |
|
|
Aláírási cél (csak ADoc)
|
signing_purpose | string |
Miért jelentkezik a személy az ADoc-aláírásokban. |
|
|
Visszahívási URL-cím
|
callback_url | string |
A dokumentum aláírásakor értesítendő URL-cím. |
|
|
Elutasítási visszahívás URL-címe
|
reject_callback_url | string |
Egy URL- cím, amely értesíti, ha egy aláíró elutasítja a dokumentumot. |
|
|
Lejárat után (perc)
|
expire_after | integer |
A hivatkozás lejáratáig percekig. Az alapértelmezett érték 2880 (két nap). |
|
|
Elutasítás gomb megjelenítése
|
show_reject_button | boolean |
Azt jelzi, hogy az aláírók elutasíthatják-e a dokumentumot az aláíró oldalon. Az alapértelmezett érték az igen. |
|
|
Dokumentum törlése (perc) után
|
delete_document_after | integer |
Percek, amíg a dokumentum törlődik a munkaterületről. Alapértelmezés szerint megmarad. |
Válaszok
| Név | Elérési út | Típus | Description |
|---|---|---|---|
|
Status
|
status | RequestStatus |
A kérés állapota. |
|
Aláíró hivatkozások:
|
temporary_signing_links | array of object |
Aláírónként egy aláíró hivatkozás. |
|
Aláíró azonosítója
|
temporary_signing_links.id | string |
Az aláíró saját azonosítója. |
|
Keresztnév
|
temporary_signing_links.member_name | string |
Az aláíró utóneve. |
|
Vezetéknév
|
temporary_signing_links.member_surname | string |
Az aláíró vezetékneve. |
|
Email
|
temporary_signing_links.member_email | string |
Az aláíró e-mail-címe. |
|
Aláíró hivatkozás
|
temporary_signing_links.temporary_signing_link | string |
Megnyílik az aláíró hivatkozása a dokumentum aláírásához. |
|
Aláíró hivatkozás azonosítója
|
temporary_signing_links.temporary_signing_link_id | string |
Az aláíró hivatkozás azonosítója. |
|
Érvényes mindaddig, amíg
|
temporary_signing_links.valid_until | integer |
Amikor a hivatkozás lejár, Unix-időbélyegként. |
|
Dokumentumok:
|
documents | array of object |
Azok a dokumentumok, amelyekhez a hivatkozások létre lettek hozva. |
|
Dokumentumazonosító
|
documents.uuid | string |
A dokumentum azonosítója. |
|
Fájlnév
|
documents.filename | string |
A dokumentumfájl neve. |
Aláírás: Hivatkozás törlése
A lejárat előtt törli az aláíró hivatkozást vagy a megosztott hivatkozást. A meghívóhivatkozások nem törölhetők.
Paraméterek
| Név | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Aláíró hivatkozás azonosítója
|
temporarySigningLinkId | True | string |
Az aláíró hivatkozás azonosítója az "Aláírás: Aláírói hivatkozások létrehozása" vagy az "Aláírás: Megosztott hivatkozás létrehozása" kimenetből. |
Válaszok
- Törzs
- AcknowledgedResponse
Aláírás: Meghívás e-mailben
Meghív egy személyt a dokumentum aláírására. Mark Sign e-mailben küldi el a meghívót.
Paraméterek
| Név | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Dokumentumazonosító
|
documentId | True | string |
A dokumentum azonosítója a "Dokumentum: Feltöltés" vagy a "Dokumentum: Feltöltés tárolóként" vagy a "Dokumentum: Lista" kimenetből. |
|
Keresztnév
|
name | True | string |
Az aláíró utóneve. |
|
Vezetéknév
|
surname | True | string |
Az aláíró vezetékneve. |
|
Email
|
True |
Az aláíró e-mail-címe. |
||
|
Nyelv
|
language | string |
A meghívó nyelve. Alapértelmezés szerint litván. |
|
|
Sikeres URL-cím
|
success_url | string |
Hová küldje el az aláírót az aláírás befejezése után. |
|
|
Cél
|
purpose | string |
Miért hívják meg a személyt? Válassza az áttekintést, ha csak megtekintésre szeretne meghívni. |
|
|
Visszahívási URL-cím
|
callback_url | string |
A dokumentum aláírásakor értesítendő URL-cím. |
Válaszok
- Törzs
- AcknowledgedResponse
Aláírás: Meghívás URL-cím alapján
E-mail küldése nélkül hozzáad egy aláírót a dokumentumhoz, és visszaadja a személyes meghívó hivatkozását a kézbesítéshez. A hivatkozás nem jár le, és nem törölhető; Ha visszavonható hivatkozásokra van szüksége, használja az "Aláírás: Aláírói hivatkozások létrehozása" parancsot.
Paraméterek
| Név | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Dokumentumazonosító
|
documentId | True | string |
A dokumentum azonosítója a "Dokumentum: Feltöltés" vagy a "Dokumentum: Feltöltés tárolóként" vagy a "Dokumentum: Lista" kimenetből. |
|
Keresztnév
|
name | True | string |
Az aláíró utóneve. |
|
Vezetéknév
|
surname | True | string |
Az aláíró vezetékneve. |
|
Email
|
True |
Az aláíró e-mail-címe. |
||
|
Sikeres URL-cím
|
success_url | string |
Hová küldje el az aláírót az aláírás befejezése után. |
|
|
Cél
|
purpose | string |
Miért hívják meg a személyt? Válassza az áttekintést, ha csak megtekintésre szeretne meghívni. |
|
|
Visszahívási URL-cím
|
callback_url | string |
A dokumentum aláírásakor értesítendő URL-cím. |
Válaszok
| Név | Elérési út | Típus | Description |
|---|---|---|---|
|
Status
|
status | RequestStatus |
A kérés állapota. |
|
Meghívó URL-címe
|
data.invitation_url | string |
Az aláírónak kézbesítendő személyes aláírási oldal hivatkozása. |
Aláírás: Megosztott hivatkozás létrehozása
Létrehoz egy aláírási hivatkozást, amelyet bárki megnyithat a dokumentumok aláírásához. Saját maga kézbesíti.
Paraméterek
| Név | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Dokumentumazonosítók
|
documents | True | array of string |
A hivatkozásra mutató dokumentumok. Használja a dokumentumazonosító-értékeket a feltöltési vagy listalépésekből. |
|
Visszahívási URL-cím
|
callback_url | string |
A dokumentum aláírásakor értesítendő URL-cím. |
|
|
Lejárat után (perc)
|
expire_after | integer |
A hivatkozás lejáratáig percekig. Az alapértelmezett érték 2880 (két nap). |
|
|
Dokumentum törlése (perc) után
|
delete_document_after | integer |
Percek, amíg a dokumentum törlődik a munkaterületről. Alapértelmezés szerint megmarad. |
Válaszok
| Név | Elérési út | Típus | Description |
|---|---|---|---|
|
Status
|
status | RequestStatus |
A kérés állapota. |
|
Aláíró hivatkozás
|
data.signing_link | string |
Az aláíráshoz bárki megnyithatja a hivatkozást. |
|
Aláíró hivatkozás azonosítója
|
data.signing_link_id | string |
Az "Aláírás: Hivatkozás törlése" hivatkozás azonosítója. |
|
Érvényes mindaddig, amíg
|
data.valid_until | integer |
Amikor a hivatkozás lejár, Unix-időbélyegként. |
Aláírás: Várja meg a következő aláírót
Megvárja, amíg a következő aláíró aláírja vagy elutasítja a dokumentumot meghívók küldése nélkül. Használja egy ciklusban, hogy több aláírót várjon lekérdezés nélkül.
Paraméterek
| Név | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Dokumentumazonosító
|
documentId | True | string |
A dokumentum azonosítója a "Dokumentum: Feltöltés" vagy a "Dokumentum: Feltöltés tárolóként" vagy a "Dokumentum: Lista" kimenetből. |
Válaszok
- Törzs
- SigningEvent
Aláírás: Várja meg az összes aláírót
Megvárja, amíg minden aláíró aláírta vagy valaki elutasította a dokumentumot, majd engedélyezi a folyamat folytatását. A timed_out állapottal végződik, amikor az idő elfogy.
Paraméterek
| Név | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Dokumentumazonosító
|
documentId | True | string |
A dokumentum azonosítója a "Dokumentum: Feltöltés" vagy a "Dokumentum: Feltöltés tárolóként" vagy a "Dokumentum: Lista" kimenetből. |
|
Időtúllépés (perc)
|
timeout_minutes | integer |
Mennyi ideig kell várni, percek alatt, mielőtt a timed_out állapottal végződik. Az alapértelmezett érték 41760 (29 nap), maximum 43200 (30 nap). |
Válaszok
- Törzs
- SigningWaitResponse
Aláírás: Várjon egy aláíróra
Megvárja, amíg egy adott aláíró aláírja a dokumentumot, majd engedélyezi a folyamat folytatását. A timed_out állapottal végződik, amikor az idő elfogy.
Paraméterek
| Név | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Dokumentumazonosító
|
documentId | True | string |
A dokumentum azonosítója a "Dokumentum: Feltöltés" vagy a "Dokumentum: Feltöltés tárolóként" vagy a "Dokumentum: Lista" kimenetből. |
|
Aláíró e-mail-címe
|
signer_email | True | string |
Az aláíró e-mailje, amelyre várnia kell, ugyanaz az e-mail, amelyet a meghíváskor használt. |
|
Időtúllépés (perc)
|
timeout_minutes | integer |
Mennyi ideig kell várni, percek alatt, mielőtt a timed_out állapottal végződik. Az alapértelmezett érték 41760 (29 nap), maximum 43200 (30 nap). |
Válaszok
- Törzs
- SigningWaitResponse
Dokumentum: Aláírás érvényességének meghosszabbítása
Frissíti a dokumentum aláírásait a hosszú távú érvényesség vagy archiválás érdekében.
Paraméterek
| Név | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Dokumentumazonosító
|
documentId | True | string |
A dokumentum azonosítója a "Dokumentum: Feltöltés" vagy a "Dokumentum: Feltöltés tárolóként" vagy a "Dokumentum: Lista" kimenetből. |
|
Level
|
level | True | string |
LT a hosszú távú érvényességhez, LTA a hosszú távú archiváláshoz. |
Válaszok
- Törzs
- AcknowledgedResponse
Dokumentum: Aláírók lekérése
Egy dokumentum aláíróinak listája az aláírási állapotukkal.
Paraméterek
| Név | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Dokumentumazonosító
|
documentId | True | string |
A dokumentum azonosítója a "Dokumentum: Feltöltés" vagy a "Dokumentum: Feltöltés tárolóként" vagy a "Dokumentum: Lista" kimenetből. |
Válaszok
| Név | Elérési út | Típus | Description |
|---|---|---|---|
|
Status
|
status | RequestStatus |
A kérés állapota. |
|
Aláírók:
|
data | array of object |
A dokumentum aláírói. |
|
Aláíró azonosítója
|
data.id | string |
Az aláíró azonosítója. |
|
Keresztnév
|
data.name | string |
Az aláíró utóneve. |
|
Vezetéknév
|
data.surname | string |
Az aláíró vezetékneve. |
|
Email
|
data.email | string |
Az aláíró e-mail-címe. |
|
Aláírás állapota
|
data.status | string |
Az aláíró aláírása: függőben, aláírva, elutasítva, felülvizsgálva, megerősítve, elutasítva vagy felülvizsgálva. |
|
Elutasítás oka
|
data.rejection_reason | string |
Az aláíró által a dokumentum elutasításának oka. |
Dokumentum: Ellenőrzés
Ellenőrzi egy dokumentum aláírását, és visszaadja az érvényesítési jelentést. A folyamat megvárja, amíg az ellenőrzés befejeződik.
Paraméterek
| Név | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Dokumentumazonosító
|
documentId | True | string |
A dokumentum azonosítója a "Dokumentum: Feltöltés" vagy a "Dokumentum: Feltöltés tárolóként" vagy a "Dokumentum: Lista" kimenetből. |
Válaszok
| Név | Elérési út | Típus | Description |
|---|---|---|---|
|
Status
|
status | RequestStatus |
A kérés állapota. |
|
Érvényes
|
data.document.is_valid | boolean |
Hogy a dokumentum aláírása érvényes-e. |
|
Érvényesség vége
|
data.document.valid_to | string |
A dokumentum érvényességének hossza. |
|
Dokumentum neve
|
data.document.name | string |
A dokumentum címe. |
|
MIME-típus
|
data.document.mimetype | string |
A dokumentum fájltípusa. |
|
Aláírások:
|
data.signatures | array of object |
Az egyes aláírások eredménye. |
|
Aláírás azonosítója
|
data.signatures.id | string |
Az aláírás azonosítója. |
|
Aláírási idő
|
data.signatures.signing_time | string |
Amikor megtörtént az aláírás. |
|
Aláírás formátuma
|
data.signatures.signature_format | string |
Az aláírás formátuma. |
|
Érvényes
|
data.signatures.is_valid | boolean |
Az aláírás érvényes-e. |
|
Érvényesség vége
|
data.signatures.valid_to | string |
Mennyi ideig marad érvényes az aláírás. |
|
Certificates
|
data.certificates | array of object |
Az aláírások által használt tanúsítványok. |
|
elemek
|
data.certificates | object | |
|
Időbélyegek
|
data.timestamps | array of object |
A dokumentumra alkalmazott időbélyegek. |
|
elemek
|
data.timestamps | object | |
|
Érvényesítési idő
|
metadata.validation_time | string |
Az ellenőrzés végrehajtásakor. |
Dokumentum: Eltávolítás
Eltávolít egy dokumentumot a munkaterületről.
Paraméterek
| Név | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Dokumentumazonosító
|
documentId | True | string |
A dokumentum azonosítója a "Dokumentum: Feltöltés" vagy a "Dokumentum: Feltöltés tárolóként" vagy a "Dokumentum: Lista" kimenetből. |
Válaszok
- Törzs
- AcknowledgedResponse
Dokumentum: Feltöltés
Feltölt egy dokumentumot, és előkészíti az aláírásra.
Paraméterek
| Név | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fájlnév
|
file_name | True | string |
A kiterjesztésű fájl neve, például contract.pdf. Ez lesz a dokumentum címe. |
|
body
|
body | True | binary | |
|
Access
|
access | string |
Ki tekintheti meg a dokumentumot. Az alapértelmezett érték privát. |
|
|
Számlázási típus
|
billing_type | True | string |
Ki fizeti az aláírásokat. |
Válaszok
| Név | Elérési út | Típus | Description |
|---|---|---|---|
|
Status
|
status | RequestStatus |
A kérés állapota. |
|
Dokumentumazonosító
|
data.uuid | string |
A dokumentum azonosítója. |
|
Fájlnév
|
data.filename | string |
A fájl neve. |
Dokumentum: Feltöltés tárolóként
Több fájlt egyesít egy aláírható tárolódokumentumban, például egy ADoc vagy ASiC-E fájlban. A fájlok feltöltése és kombinálása egyetlen lépésben.
Paraméterek
| Név | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Dokumentum típusa
|
document_type | True | string |
A létrehozni kívánt dokumentum típusa. |
|
Fájlnév
|
file_name | True | string |
A kiterjesztésű fájl neve, például contract.pdf. |
|
Fájl tartalma
|
file_content | True | byte |
A fájl tartalma. |
|
Fájltípus (csak ADoc)
|
adoc_file_type | string |
A fájl szerepe a tárolóban. Csak akkor használatos, ha a dokumentum típusa ADoc. |
Válaszok
| Név | Elérési út | Típus | Description |
|---|---|---|---|
|
Status
|
status | RequestStatus |
A kérés állapota. |
|
Dokumentumazonosító
|
data.uuid | string |
A dokumentum azonosítója. |
|
Fájlnév
|
data.filename | string |
A dokumentumfájl neve. |
Dokumentum: Letöltés
Letölti a dokumentumot az eddig összegyűjtött összes aláírással.
Paraméterek
| Név | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Dokumentumazonosító
|
documentId | True | string |
A dokumentum azonosítója a "Dokumentum: Feltöltés" vagy a "Dokumentum: Feltöltés tárolóként" vagy a "Dokumentum: Lista" kimenetből. |
Válaszok
A dokumentumfájl tartalma.
- Fájl tartalma
- file
Dokumentum: Lista
Elsőként a munkaterületen található dokumentumokat sorolja fel.
Paraméterek
| Név | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Kereső
|
query | string |
A dokumentumcímekben és fájlnevekben keresendő kifejezés. |
|
|
Offset
|
offset | integer |
Hány dokumentumot kell kihagyni. |
|
|
Limit
|
limit | integer |
Hány dokumentumot kell visszaadni. Az alapértelmezett érték 10. |
Válaszok
| Név | Elérési út | Típus | Description |
|---|---|---|---|
|
Status
|
status | RequestStatus |
A kérés állapota. |
|
Dokumentumok:
|
data | array of object |
A dokumentumok. |
|
Dokumentumazonosító
|
data.uuid | string |
A dokumentum azonosítója. |
|
Fájlnév
|
data.filename | string |
A fájl neve. |
|
Dokumentum állapota
|
data.status | string |
A dokumentum aláírási állapota, például mentett (aláírásra vár), signed_partially vagy aláírt. |
|
Feltöltve:
|
data.uploaded_at | date-time |
A dokumentum feltöltésekor. |
|
Total
|
total | integer |
Az egyező dokumentumok teljes száma. |
Dokumentum: Állapot lekérése
Lekéri egy dokumentum aláírási állapotát.
Paraméterek
| Név | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Dokumentumazonosító
|
documentId | True | string |
A dokumentum azonosítója a "Dokumentum: Feltöltés" vagy a "Dokumentum: Feltöltés tárolóként" vagy a "Dokumentum: Lista" kimenetből. |
Válaszok
| Név | Elérési út | Típus | Description |
|---|---|---|---|
|
Status
|
status | RequestStatus |
A kérés állapota. |
|
Dokumentum állapota
|
data.document_status | string |
Az aláírás állapota: mentett (aláírásra vár), signed_partially (néhány aláírt) vagy aláírt (mindenki aláírta). |
Definíciók
SigningEvent
| Név | Elérési út | Típus | Description |
|---|---|---|---|
|
Dokumentumazonosító
|
uuid | string |
A dokumentum azonosítója. |
|
Dokumentum állapota
|
status | string |
A dokumentum aláírási állapota, például aláírt vagy signed_partially. Az elutasítás megjelenik az aláíró állapotában. |
|
Aláírók száma
|
members_count | integer |
Hány embert hívtak meg aláírásra. |
|
Aláírt darabszám
|
signed_members_count | integer |
Hányan írtak alá. |
|
Aláírók:
|
members | array of object |
Mindenki, akit meghívtak az aláírásra. |
|
Aláíró azonosítója
|
members.id | string |
Az aláíró azonosítója. |
|
Keresztnév
|
members.member_name | string |
Az aláíró utóneve. |
|
Vezetéknév
|
members.member_surname | string |
Az aláíró vezetékneve. |
|
Email
|
members.member_email | string |
Az aláíró e-mail-címe. |
|
Aláírás állapota
|
members.status | string |
Az aláíró állapota, például függőben, aláírva vagy elutasítva. |
AcknowledgedResponse
| Név | Elérési út | Típus | Description |
|---|---|---|---|
|
Status
|
status | RequestStatus |
A kérés állapota. |
SigningWaitResponse
| Név | Elérési út | Típus | Description |
|---|---|---|---|
|
Dokumentum állapota
|
document_status | string |
A várakozás befejezése: aláírt, elutasított vagy timed_out. |
|
Elutasította:
|
rejected_by | string |
Ki utasította el a dokumentumot, ha az el lett utasítva. |
|
Elutasítás oka
|
rejection_reason | string |
Az aláíró által megadott ok, ha a dokumentumot elutasították. |
Kérelem állapota
fájl
Ez a fájl alapszintű adattípusa.