OK-dokument (onafhankelijke uitgever) (preview)
OK-dokument biedt een eenvoudig te gebruiken en aanpasbaar elektronisch handtekening- en digitaal documentdistributieplatform dat naadloos kan worden geïntegreerd in uw bestaande systemen
Deze connector is beschikbaar in de volgende producten en regio's:
| Dienst | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Logic-apps | Standaard | Alle Logic Apps-regio's , met uitzondering van het volgende: - Azure Government-regio's - Azure China-regio's - Us Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Contactpersoon | |
|---|---|
| Naam | Seyfor Slovensko a.s. |
| URL | https://www.seyfor.com |
| E-mailen | tomas.szarka@seyfor.com |
| Connectormetagegevens | |
|---|---|
| Uitgever | Seyfor Slovensko, a.s. |
| Webpagina | https://okdokument.com/ |
| Privacybeleid | https://okdokument.com/_user/files/OKdokument/gdpr-en.pdf |
| Categorieën | Productiviteit |
OK-dokument - elektronische handtekening
OK-dokument biedt een eenvoudig te gebruiken en aanpasbaar elektronisch handtekening- en digitaal inhoudsdistributieplatform dat naadloos kan worden geïntegreerd met uw bestaande systemen.
Uitgever
Seyfor Slovensko, a.s.
Vereiste voorwaarden
U moet een account hebben op https://app.okdokument.com en een geldige API-sleutel die is gegenereerd door de OK-dokument-service .
Ondersteunde bewerkingen
1. Document uploaden
Actie die wordt gebruikt voor het uploaden van een PDF-bestand naar de documenthandtekeningsservice. Deze actie neemt een base64-tekenreeks en uploadt deze naar het OK-dokument-API-platform .
Document geeft tijdens de levensduur verschillende statussen door. OK-dokument-API maakt gebruik van de volgende documentstatussen:
- tags: status waarmee tekstlabels worden doorzocht en handtekeningacrovelden worden ingevoegd. Nadat het invoegen van acrofields is geslaagd, wordt de status automatisch gewijzigd in het toevoegen van de functie
- tostamp – status die digitale stempel in het document invoegt
- tosign - document gereed om te worden ondertekend
- ondertekend – ondertekend document (binnen de opgegeven signatureRequestID)
- errorsendinfo : fout tijdens het aanroepen van de infoservice
- geannuleerd – geannuleerd document – ondertekenaar heeft op de knop Annuleren gedrukt in het document
Acrofields van handtekeningen
Acrofield is een type actief veld dat wordt ondersteund in PDF. Een acroveld voor handtekeningen is een speciaal type actief veld waarmee een handtekening op een vaste locatie in een document kan worden ingevoegd. Acrofields kunnen worden ingevoegd in PDF-bestanden met gespecialiseerde PDF-hulpprogramma's zoals Adobe PRO of met sjabloonhulpprogramma's zoals JasperReport.
Tags
Een tag vertegenwoordigt een unieke tekstwaarde die door de API-server wordt gescand. Als deze wordt gevonden, wordt het acroveld van de handtekening ingevoegd. De tagzoekfunctie wordt geleverd door de documentstatus 'tags', die moet worden ingesteld wanneer de JSON-/documentservice wordt aangeroepen. OKdokument-API ondersteunt de volgende tags voor optionele handtekening:
_SO1_
_SO2_
_SO3_
_SO4_
_SO5_
OKdokument-API ondersteunt de volgende tags voor verplichte handtekening: _SC1__SC2__SC3_ _SC4__SC5_
Als verplichte tags worden gebruikt, moeten alle zichtbare verplichte handtekeningacrovelden zijn ondertekend voordat het document wordt ingediend.
Als het niet mogelijk is om documenten voor te bereiden met handtekeningacrofields of tags bij het registreren van signatureRequest, is het mogelijk om de functionaliteit 'overal ondertekenen' in te schakelen, waardoor de gebruiker het document op elke locatie kan ondertekenen, eenvoudig waar de gebruiker klikt/tikt
Document converteren naar PDF
OKdokument-API ondersteunt conversie van .doc, .docx, .xls, .xlsx in PDF-bestandsindeling. Het bronbestand kan ook tags bevatten, OKdokument-API voert eerst de bestandsconversie uit en voegt vervolgens automatisch handtekeningacrovelden in.
Als u het bestand wilt converteren naar PDF, moet u de naam van het document invullen. Deze parameter is verplicht als u de bestandsconversie naar pdf-indeling wilt uitvoeren. Voor conversie moet het bestandspostvoegsel het volgende zijn:
- contract.doc
- contract.docx
- contract.xls
- contract.xlsx
Documenten opslaan en verwijderen
DE OK-dokument-API fungeert niet als de rol van een permanent archief van ondertekend document. De volgende regels worden toegepast:
- Ondertekend document wordt 10 dagen na ondertekening automatisch verwijderd
- Niet-ondertekend document wordt na 30 dagen na het uploaden automatisch verwijderd
2. Handtekeningaanvraag
Deze actie wordt gebruikt voor het genereren van de handtekeningaanvraag-id. Binnen deze actie moet u document-id gebruiken. De document-id is een resultaat van de uploadactie Voor documenten.
In deze actie kunt u uw handtekeningproces transformeren in een handtekeningproces met meerdere fases. Door extra parameter 'Handtekeningvelden' toe te voegen, kunt u beheren wat er beschikbaar moet zijn in elke handtekeningaanvraag. U kunt acrofields gebruiken met interne namen
_SO1_
_SO2_
_SO3_
_SO4_
_SO5_
OR
_SC1_
_SC2_
_SC3_
_SC4_
_SC5_
Deze actie kan meerdere keren in uw proces worden gebruikt. De actie Handtekeningaanvraag wordt gegenereerd in de OK-dokument-service als 'Handtekeningaanvraag' en deze id is uniek voor elke actie Ondertekenen.
Als u een aanvraag voor documenthandtekening wilt verzenden, gebruikt u de URL van het antwoordkenmerk en gebruikt u deze in e-mail, pushmeldingen of MS Teams om iemand te vragen een specifiek document te ondertekenen.
Zodra het document is ondertekend, kunt u 'Handtekeningaanvraag' gebruiken om de documentstatus te wijzigen in 'tosign' en nieuwe signatureRequestId te maken en het document voor te bereiden op de volgende handtekening. Dan herhaalt het proces stap 3 – 5.
Voorbeeld van handtekeningaanvraag met één verplicht acroveld
_SC1_
Voorbeeld van handtekeningaanvraag met één verplicht acroveld en optioneel acroveld in één handtekeningaanvraag_SC1_;_SO2_
Aanvullende regels in handtekeningaanvraag
Aanvullende regels kunnen worden gebruikt voor het volgende:
- De functie Sign Anywhere uitschakelen of inschakelen
- Vooraf gedefinieerde waarde voor ondertekenaarnaam
- de invoer voor de ondertekenaarnaam inschakelen
- verzenden van handtekeningaanvraag vanuit OK Dokument inschakelen
- e-mailherinnering inschakelen
- OTP-configuratie (eenmalig wachtwoord) via e-mail of sms
- document ondertekenen met OTP
- ondertekening met de muis uitschakelen
| Regelnaam | Kenmerk | Description |
|---|---|---|
| signAnywhereEnabled | waar/onwaar | parameter voor het uitschakelen van de functie Overal ondertekenen |
| guiRequestSignerName | waar/onwaar | parameter voor het inschakelen van de invoer voor de ondertekenaarnaam |
| guiSignerName | Naam van ondertekenaar | vooraf gedefinieerde waarde voor ondertekennaam, maximaal 40 tekens. Als guiRequestSignerName is ingeschakeld, kan de ondertekenaar de naam van de ondertekenaar wijzigen. |
| signAnywhereEnabled | waar/onwaar | parameter voor het uitschakelen van de functie Overal ondertekenen |
| emailTo | E-mailadres van ondertekenaar | E-mail van ondertekenaars waarnaar de URL van de handtekeningaanvraag wordt verzonden |
| geleverd worden. | ||
| emailFrom | E-mail van afzender | E-mail van afzenders. Verplicht als e-mailTo-regel wordt gebruikt |
| nameFrom | Naam van afzender | De naam van afzenders, die wordt gebruikt in de e-mailsjablonen |
| e-mailkennisgeving | Regel waarmee e-mailherinnering wordt ingeschakeld. E-mailherinnering verzendt elke ochtend om 7:00 uur e-mail voor handtekeningaanvragen die niet zijn ondertekend. Het e-mailbericht wordt verzonden naar emailTo en emailFrom , volgens de configuratie signatureRequest. | |
| emailFinal | E-mailadres van ondertekenaar | E-mail voor het bezorgen van het ondertekende document. Als emailFinal zonder parameter is, wordt het ondertekende document verzonden naar emailTo. |
| openOtpPhone | Telefoon voor ondertekenaar | Nummer van ondertekenaars waarop het eenmalige wachtwoord voor toegang tot het document wordt bezorgd. Als u SMS OTP wilt gebruiken, moet u handtekeningaanvraagpakket kopen met SMS. |
| openOtpEmail | E-mailadres van ondertekenaar | Ondertekenaars e-mail waarnaar het eenmalige wachtwoord voor toegang tot het document wordt bezorgd. |
| signOtpPhone | Telefoon voor ondertekenaar | Telefoonnummer van ondertekenaars waarop het eenmalige wachtwoord voor het ondertekenen van het document wordt bezorgd. OTP-handtekening vereist handtekening acrofield. |
| signOtpEmail | E-mailadres van ondertekenaar | Ondertekenaars e-mail waarnaar het eenmalige wachtwoord voor het ondertekenen van het document wordt bezorgd. OTP-handtekening vereist handtekening acrofield. |
| lang | sk, cs, en, ro, uk, pl, pt, hu | Taal van e-mail en sms-sjabloon, als de regel niet is ingesteld, Slowaaks als standaardtaal wordt gebruikt. |
| mouseSignature | false | Regel voor het uitschakelen van ondertekening met de muis. |
Syntaxis voor het schrijven van regels voor handtekeningaanvragen
RuleName-Value
Syntaxis voor het schrijven van meerdere regels voor handtekeningaanvragen
RuleName1-Value_RuleName2-Value_RuleName3-Value
Voorbeeld van handtekeningaanvraag met ingeschakelde sign anywhere
signAnywhereEnabled-true
Voorbeeld van handtekeningaanvraag met uitgeschakelde sign anywhere en ingeschakelde signer-naam met vooraf ingevulde waarde
guiSignerName-John Doe_guiRequestSignerName-true_signAnywhereEnabled-false
Voorbeeld van handtekeningaanvraag met uitgeschakelde sign anywhere, ingeschakelde naam van ondertekenaar met vooraf ingevulde waarde, gedefinieerde OTP-e-mail om handtekeningaanvraag te openen, e-mail waar handtekeningaanvraag wordt verzonden, taal van e-mailsjabloon, e-mail van afzender van handtekeningaanvraag
guiSignerName-John Doe_guiRequestSignerName-true_signAnywhereEnabled-false_openOtpEmail-john.doe@somefakeemail.com_emailTo-john.doe@somefakeemail.com_lang-sk_emailFrom-sender@someofficetenant.onmicrosoft.com_mouseSignature-false
Verlooptijd
De standaardwaarde voor het verlopen van de handtekeningaanvraag is 24 uur. U kunt dit tijdsbereik uitbreiden tot 10 dagen met behulp van deze parameter expirationTime. Verlooptijd van handtekeningaanvraag-id. Tijd in Milliseconden sinds 1 januari 1970 00:00:00 UTC
E-mailen
Met de OKdokument-API kunt u de URL signatureRequest delen via e-mail. Als u e-mail wilt verzenden, moet u regels gebruiken:
- emailTo – e-mail van de ondertekenaar
- emailFrom – e-mail van de afzender
- nameFrom – naam van de afzender
E-mail wordt bezorgd van okdokument@okdokument.sk, maar wanneer de ondertekenaar op de knop Beantwoorden/Allen beantwoorden raakt, wordt het antwoord rechtstreeks naar de afzender verzonden (emailFrom). U wordt aangeraden ook de volgende regels te gebruiken voor aanvullende instellingen in het ondertekeningsproces:
- emailFinal : e-mail voor het verzenden van het ondertekende document. EmailTo wordt standaard gebruikt, maar kan worden gewijzigd. In het geval van meervoudige ondertekening gebruikt u deze regel in de laatste ondertekeningsronde en vult u alle e-mailadressen van zangers in. Voorbeeld: emailFinalemail@address.com|email2@address.com
- emailNotification - e-mail voor het verzenden van een herinnering dat het document op handtekening wacht.
- taal : taal van de e-mailsjabloon
- bestandsnaam : documentnaam, die wordt gebruikt in de e-mailsjabloon. Als de bestandsnaam niet is ingevuld, wordt de technische document-id gebruikt als documentnaam
3. Wacht op handtekening
Triggeractie 'Wachten op handtekening' kan in uw proces worden gebruikt. De actie 'Wachten op handtekening' wacht totdat de documenthandtekening is bevestigd in de DOKUMENT-service van OK door op de knop Verzenden te klikken. Zodra de handtekening is verzonden, is deze triggeractie voltooid. U kunt deze actie gebruiken als u moet wachten op bevestiging van documenthandtekening in uw proces.
4. Ondertekend document downloaden
Met deze actie kunt u ondertekend document downloaden en het document verwerken in aanvullende stappen in uw systeem of opslaan in SharePoint of een ander documentopslagsysteem.
5. Document verwijderen
Zodra het document is ondertekend, kunt u het document handmatig verwijderen uit de OK-dokument-service . Alle geüploade documenten worden na 60 dagen automatisch verwijderd en ondertekende documenten worden na 10 dagen verwijderd.
Referenties verkrijgen
U kunt de API-sleutel ophalen die is vereist voor het gebruik van de OK-dokument-service door u te abonneren op https://okdokument.com/en/about/api/.
Bekende problemen en beperkingen
Momenteel gelden er beperkingen voor het gebruik van acrofields en tags. Het enige mogelijke gebruik van tags of acrofields is vooraf gedefinieerde tekenreeksindeling in uw proces: _SC1_, _SC2_, _SC3_, _SC4_, _SC5_ of _SO1_, _SO2_, _SO3_, _SO4_, _SO5_ .
Aangepaste interne namen van acrofield worden momenteel gebruikt:
| Selectievakje | Acrofield |
|---|---|
| Optioneel selectievakje | koolstofmonoxide |
| Verplicht selectievakje | CR |
| Tekstveld | Acrofield |
|---|---|
| Optioneel Tekstveld | NAAR |
| Verplicht tekstveld | TC |
| Groep keuzerondje | Acrofield |
|---|---|
| Optionele keuzerondjegroep | RO |
| Verplichte keuzerondje groep | RC |
| Keuzelijst met invoervak | Acrofield |
|---|---|
| Optionele keuzelijst met invoervak | CBO |
| Verplichte keuzelijst met invoervak | CBC |
Implementatie-instructies
Gebruik de instructies hier om deze connector te implementeren als aangepaste connector in Microsoft Power Automate, Power Apps of Azure LogicApps.
Een verbinding maken
De connector ondersteunt de volgende verificatietypen:
| standaard | Parameters voor het maken van verbinding. | Alle regio's | Niet deelbaar |
Verstek
Van toepassing: Alle regio's
Parameters voor het maken van verbinding.
Dit is geen deelbare verbinding. Als de power-app wordt gedeeld met een andere gebruiker, wordt een andere gebruiker gevraagd om expliciet een nieuwe verbinding te maken.
| Naam | Typologie | Description | Verplicht |
|---|---|---|---|
| OK-dokument-API-sleutel | beveiligde string | De API-sleutel voor de app/abonnement die is uitgegeven door Anasoft | Klopt |
Beperkingslimieten
| Name | Aanroepen | Verlengingsperiode |
|---|---|---|
| API-aanroepen per verbinding | 100 | 60 seconden |
Acties
| Document uploaden |
Document uploaden |
| Document verwijderen |
Document verwijderen |
| Handtekeningaanvraag |
Handtekeningaanvraag |
| Ondertekend document downloaden |
Ondertekend document downloaden |
Document uploaden
Document uploaden
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Documentbewerking
|
state | string |
Documentbewerking |
|
|
Bestand
|
file | True | binary |
Bestandsinhoud |
|
Bestandsnaam
|
filename | string |
Bestandsnaam met extensie |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Document-id
|
result | string |
Document-id |
Document verwijderen
Document verwijderen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Document-id
|
Document ID | True | string |
Document-id |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
code
|
code | string |
code |
|
message
|
message | string |
message |
|
statuscode
|
statusCode | integer |
statuscode |
Handtekeningaanvraag
Handtekeningaanvraag
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Document-id
|
id | True | string |
Document-id van de actie Document uploaden |
|
Handtekeningvelden
|
SIGNATURE | string |
Handtekeningvelden in uw document |
|
|
Verlooptijd
|
expirationTime | string |
Verlooptijd in Milliseconden |
|
|
Naam
|
name | string |
Naam van het acroveld |
|
|
Waarde
|
value | string |
Acrofield-waarde |
|
|
Alleen-lezen
|
readOnly | boolean |
Acrofield is alleen-lezen |
|
|
Aanvullende regels
|
rules | string |
Regels voor het definiëren van het proces voor handtekeningaanvragen |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Id van handtekeningaanvraag
|
result | string |
Id van handtekeningaanvraag |
|
URL voor handtekeningaanvraag
|
url | string |
url |
Ondertekend document downloaden
Ondertekend document downloaden
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Document-id
|
Document ID | True | string |
Document-id van de actie Document uploaden |
Retouren
Documentinhoud
- Documentinhoud
- binary
Triggers
| Wachten op documenthandtekening |
Wachten op documenthandtekening |
Wachten op documenthandtekening
Wachten op documenthandtekening
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id van handtekeningaanvraag
|
signatureRequestId | True | string |
Handtekeningaanvraag-id van de actie Handtekeningaanvraag |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
code
|
code | string |
code |
|
statuscode
|
statusCode | integer |
statuscode |
Definities
binair
Dit is het basisgegevenstype 'binair'.