OK dokument (Éditeur indépendant) (préversion)
OK dokument offre une plateforme de distribution de documents électroniques facile à utiliser et personnalisable qui s’intègre en toute transparence dans vos systèmes existants
Ce connecteur est disponible dans les produits et régions suivants :
| Service | classe | Régions |
|---|---|---|
| Copilot Studio | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Applications logiques | Norme | Toutes les régions Logic Apps , à l’exception des suivantes : - Régions Azure Government - Régions Azure Chine - Us Department of Defense (DoD) |
| Power Apps | Premium | Toutes les régions Power Apps , à l’exception des suivantes : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Contact | |
|---|---|
| Nom | Seyfor Slovensko a.s. |
| URL | https://www.seyfor.com |
| Messagerie électronique | tomas.szarka@seyfor.com |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | Seyfor Slovensko, a.s. |
| Site internet | https://okdokument.com/ |
| Politique de confidentialité | https://okdokument.com/_user/files/OKdokument/gdpr-en.pdf |
| Catégories | Productivité |
OK dokument - signature électronique
OK dokument offre une signature électronique facile à utiliser et personnalisable et une plateforme de distribution de contenu numérique qui s’intègre en toute transparence à vos systèmes existants.
Éditeur
Seyfor Slovensko, a.s.
Prerequisites
Vous devez disposer d’un compte sur https://app.okdokument.com et d’une clé API valide générée par le service dokument OK .
Opérations prises en charge
1. Chargement du document
Action utilisée pour charger un fichier PDF dans le service de signature de document. Cette action prend une chaîne base64 et la charge sur la plateforme d’API dokument OK .
Le document passe plusieurs états pendant sa durée de vie. L’API dokument OK utilise les états de document suivants :
- balises : état qui recherche les balises de texte et insère des acrofields de signature. Une fois l’insertion réussie d’acrofields, elle change automatiquement l’état de tosign
- tostamp : état qui insère un tampon numérique dans le document
- tosign : document prêt à être signé
- signé – document signé (dans signatureRequestID donné)
- errorsendinfo : erreur lors de l’appel du service d’informations
- annulé – document annulé – signataire a appuyé sur le bouton « Annuler » dans le document
Acrofields de signature
Acrofield est un type de champ actif pris en charge au format PDF. Un acrofield de signature est un type spécial de champ actif qui permet d’insérer une signature dans un document à un emplacement fixe. Les Acrofields peuvent être insérés dans des fichiers PDF spécialisés avec des outils PDF spécialisés tels qu’Adobe PRO ou avec des outils de modèle tels que JasperReport.
Étiquettes
Une balise représente une valeur de texte unique que le serveur d’API analyse. S’il le trouve, il insère l’acrofield de signature à sa place. La recherche de balises est fournie par l’état du document « tags », qui doit être défini lorsque le service JSON/document est appelé. L’API OKdokument prend en charge les balises suivantes pour la signature facultative :
_SO1_
_SO2_
_SO3_
_SO4_
_SO5_
L’API OKdokument prend en charge les balises suivantes pour la signature obligatoire : _SC1__SC2__SC3_ _SC4__SC5_
Si des balises obligatoires sont utilisées, tous les acrofields de signature obligatoire visibles doivent être signés avant de soumettre le document.
Dans le cas où il n’est pas possible de préparer des documents avec des acrofields de signature ou des balises lors de l’inscription de signatureRequest, il est possible d’activer la fonctionnalité « signer n’importe où », ce qui permettra à l’utilisateur de signer le document à n’importe quel emplacement, simple où l’utilisateur clique/appuie sur
Convertir un document au format PDF
L’API OKdokument prend en charge la conversion de .doc, .docx, .xls, .xlsx au format de fichier PDF. Le fichier source peut également contenir des balises, l’API OKdokument effectue d’abord la conversion de fichier, puis insère automatiquement des acrofields de signature.
Pour convertir un fichier au format PDF, vous devez renseigner le nom du document. Ce paramètre est obligatoire si vous souhaitez effectuer la conversion de fichier au format PDF. Pour la conversion, le postfix de fichier doit être :
- contract.doc
- contract.docx
- contract.xls
- contract.xlsx
Stockage et suppression de documents
L’API dokument OK ne sert pas le rôle d’une archive permanente du document signé. Les règles suivantes sont appliquées :
- Le document signé est automatiquement supprimé 10 jours après la signature
- Le document non signé est automatiquement supprimé après 30 jours après le chargement
2. Demande de signature
Cette action est utilisée pour générer l’ID de demande de signature. Dans cette action, vous devez utiliser l’ID de document. L’ID de document est un résultat de l’action de chargement de document.
Dans cette action, vous pouvez transformer votre processus de signature en processus de signature multistage. L’ajout de paramètres supplémentaires « Champs de signature » vous permet de gérer ce qui doit être disponible dans chaque demande de signature. Vous pouvez utiliser des acrofields avec des noms internes
_SO1_
_SO2_
_SO3_
_SO4_
_SO5_
OR
_SC1_
_SC2_
_SC3_
_SC4_
_SC5_
Cette action peut être utilisée plusieurs fois dans votre processus. L’action de demande de signature est générée dans le service OK dokument en tant que « demande de signature » et cet ID est unique pour chaque action « Sign ».
Pour envoyer une demande de signature de document, vous utilisez l’URL de l’attribut de réponse et l’utilisez dans un e-mail, une notification Push ou MS Teams pour demander à quelqu’un de signer un document spécifique.
Une fois le document signé, vous pouvez utiliser « Demande de signature » pour remplacer l’état du document par « tosign » et créer une signatureRequestId et préparer le document pour la signature suivante. Le processus répète les étapes 3 à 5.
Exemple de demande de signature avec un acrofield obligatoire
_SC1_
Exemple de demande de signature avec un acrofield obligatoire et sur un acrofield facultatif dans une demande de signature_SC1_;_SO2_
Règles supplémentaires dans la demande de signature
Des règles supplémentaires peuvent être utilisées pour :
- Désactiver ou activer la fonctionnalité Sign Anywhere
- Valeur prédéfinie pour le nom du signataire
- activation de l’entrée pour le nom du signataire
- activation de l’envoi d’une demande de signature à partir d’OK Dokument
- activer le rappel par e-mail
- Configuration otP (mot de passe unique) par e-mail ou SMS
- signer un document avec otP
- désactiver la signature avec la souris
| Nom de la règle | Paramètre | Descriptif |
|---|---|---|
| signAnywhereEnabled | true/false | paramètre de désactivation de la fonction sign anywhere |
| guiRequestSignerName | true/false | paramètre d’activation de l’entrée pour le nom du signataire |
| guiSignerName | Nom du signataire | valeur prédéfinie pour le nom du signataire, 40 caractères maximum. Si guiRequestSignerName est activé, le nom du signataire peut être modifié par le signataire. |
| signAnywhereEnabled | true/false | paramètre de désactivation de la fonction sign anywhere |
| emailTo | E-mail du signataire | Envoyer un e-mail aux signataires auxquels l’URL de demande de signature sera envoyée |
| être livré. | ||
| emailFrom | E-mail de l’expéditeur | E-mail des expéditeurs. Obligatoire si la règle emailTo est utilisée |
| nameFrom | Nom de l’expéditeur | Nom des expéditeurs, qui sera utilisé dans les modèles d’e-mail |
| emailNotification | Règle qui active le rappel par e-mail. Le rappel par e-mail envoie un e-mail tous les matins à 7h00 pour les demandes de signature qui ne sont pas signées. L’e-mail est envoyé à emailTo et emailFrom, en fonction de la configuration signatureRequest. | |
| emailFinal | E-mail du signataire | E-mail pour remettre le document signé. Si emailFinal est sans paramètre, le document signé est envoyé à emailTo. |
| openOtpPhone | Téléphone du signataire | Le numéro de téléphone des signataires auquel le mot de passe unique pour accéder au document est remis. Pour utiliser sms OTP, vous devez acheter un package de demande de signature avec SMS. |
| openOtpEmail | E-mail du signataire | Les signataires adressent un e-mail auquel le mot de passe unique pour accéder au document sera remis. |
| signOtpPhone | Téléphone du signataire | Numéro de téléphone des signataires auquel le mot de passe unique pour la signature du document sera remis. La signature OTP nécessite un acrofield de signature. |
| signOtpEmail | E-mail du signataire | Les signataires adressent un e-mail auquel le mot de passe unique pour la signature du document sera remis. La signature OTP nécessite un acrofield de signature. |
| lang | sk, cs, en, ro, uk, pl, pt, hu | Langue du modèle e-mail et SMS, si la règle n’est pas définie, le slovaque est utilisé comme langue par défaut. |
| mouseSignature | false | Règle de désactivation de la signature avec la souris. |
Syntaxe permettant d’écrire des règles de demande de signature
RuleName-Value
Syntaxe permettant d’écrire plusieurs règles de demande de signature
RuleName1-Value_RuleName2-Value_RuleName3-Value
Exemple de demande de signature avec sign Anywhere activé
signAnywhereEnabled-true
Exemple de demande de signature avec sign Anywhere désactivé et nom du signataire activé avec une valeur préremplie
guiSignerName-John Doe_guiRequestSignerName-true_signAnywhereEnabled-false
Exemple de demande de signature avec sign Anywhere désactivé, nom du signataire activé avec valeur préremplie, e-mail OTP défini pour ouvrir la demande de signature, e-mail où la demande de signature est envoyée, langue du modèle de courrier électronique, adresse e-mail de l’expéditeur de la demande de signature
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
Délai d’expiration
La valeur par défaut pour l’expiration de la demande de signature est de 24 heures. Vous pouvez étendre cette plage de temps jusqu’à 10 jours à l’aide de ce paramètre expirationTime. Heure d’expiration de l’ID de demande de signature. Durée en millisecondes depuis le 1er janvier 1970 00:00:00 UTC
Messagerie électronique
L’API OKdokument vous permet de partager l’URL signatureRequest par e-mail. Pour envoyer un e-mail, vous devez utiliser des règles :
- emailTo : e-mail du signataire
- emailFrom : e-mail de l’expéditeur
- nameFrom : nom de l’expéditeur
L’e-mail est remis à partir de okdokument@okdokument.sk, mais lorsque le signataire atteint le bouton répondre/répondre à tous les boutons, la réponse est envoyée directement à l’expéditeur (emailFrom). Nous vous recommandons également d’utiliser les règles suivantes pour une configuration supplémentaire dans le processus de signature :
- emailFinal : e-mail pour l’envoi du document signé. Par défaut, emailTo est utilisé, mais il peut être modifié. En cas de signature multi-arrondi, utilisez cette règle dans la dernière série de signature et remplissez toutes les adresses e-mail de tous les chanteurs. Exemple : emailFinalemail@address.com|email2@address.com
- emailNotification : e-mail pour l’envoi d’un rappel indiquant que le document est en attente de signature.
- langue : langue du modèle d’e-mail
- nom de fichier : nom du document, qui sera utilisé dans le modèle d’e-mail. Si le nom de fichier n’est pas rempli, l’ID de document technique sera utilisé comme nom de document
3. Attendre la signature
L’action de déclencheur « Attendre la signature » peut être utilisée dans votre processus. L’action « Attendre la signature » attend que la signature du document soit confirmée dans le service dokument OK en cliquant sur le bouton Envoyer. Une fois la signature envoyée, cette action de déclencheur est terminée. Vous pouvez utiliser cette action si vous devez attendre la confirmation de signature de document dans votre processus.
4. Télécharger le document signé
Cette action vous permet de télécharger le document signé et de traiter le document en étapes supplémentaires dans votre système ou de l’enregistrer dans SharePoint ou dans un autre système de stockage de documents.
5. Supprimer le document
Une fois votre document signé, vous pouvez supprimer le document du service dokument OK à l’aide de la suppression manuelle d’action. Tous les documents chargés sont supprimés automatiquement après 60 jours et les documents signés sont supprimés après 10 jours.
Obtention des informations d’identification
Vous pouvez obtenir la clé API requise pour utiliser le service dokument OK en vous abonnant à https://okdokument.com/en/about/api/.
Problèmes connus et limitations
Actuellement, il existe des limitations à l’utilisation d’acrofields et de balises. La seule utilisation possible de balises ou d’acrofields est un format de chaîne prédéfini dans votre processus : _SC1_, _SC2_, _SC3_, _SC4_, _SC5_ ou _SO1_, _SO2_, _SO3_, _SO4_, _SO5_ .
Les noms internes acrofield personnalisés sont actuellement utilisés :
| Case à cocher | Acrofield |
|---|---|
| Case à cocher facultative | Monoxyde de carbone |
| Case à cocher obligatoire | CR |
| Champ de texte | Acrofield |
|---|---|
| TextField facultatif | À |
| Champ texte obligatoire | TC |
| Groupe de cases d’option | Acrofield |
|---|---|
| Groupe de cases d’option facultatif | RO |
| Groupe de cases d’option obligatoires | RC |
| Déroulante | Acrofield |
|---|---|
| Zone de liste modifiable facultative | CBO |
| Zone de liste modifiable obligatoire | SRC |
Instructions de déploiement
Utilisez les instructions fournies ici pour déployer ce connecteur en tant que connecteur personnalisé dans Microsoft Power Automate, Power Apps ou Azure LogicApps.
Création d’une connexion
Le connecteur prend en charge les types d’authentification suivants :
| Par défaut | Paramètres de création de connexion. | Toutes les régions | Non partageable |
Faire défaut
Applicable : Toutes les régions
Paramètres de création de connexion.
Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.
| Nom | Type | Descriptif | Obligatoire |
|---|---|---|---|
| OK dokument API Key | securestring | Clé API d’application/abonnement émise par Anasoft | Vrai |
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
| Chargement de document |
Chargement de document |
| Demande de signature |
Demande de signature |
| Suppression de document |
Suppression de document |
| Télécharger le document signé |
Télécharger le document signé |
Chargement de document
Chargement de document
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Opération de document
|
state | string |
Opération de document |
|
|
Fichier
|
file | True | binary |
Contenu du fichier |
|
Filename
|
filename | string |
Nom de fichier avec extension |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Document ID
|
result | string |
Document ID |
Demande de signature
Demande de signature
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Document ID
|
id | True | string |
ID de document à partir de l’action Chargement de document |
|
Champs de signature
|
SIGNATURE | string |
Champs de signature dans votre document |
|
|
Délai d’expiration
|
expirationTime | string |
Délai d’expiration en millisecondes |
|
|
Nom
|
name | string |
Nom de l’acrofield |
|
|
Valeur
|
value | string |
Valeur Acrofield |
|
|
Lecture seule
|
readOnly | boolean |
Acrofield est en lecture seule |
|
|
Règles supplémentaires
|
rules | string |
Règles pour définir le processus de demande de signature |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de demande de signature
|
result | string |
ID de demande de signature |
|
URL de demande de signature
|
url | string |
URL |
Suppression de document
Suppression de document
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Document ID
|
Document ID | True | string |
Document ID |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
code
|
code | string |
code |
|
Message
|
message | string |
Message |
|
statusCode
|
statusCode | integer |
statusCode |
Télécharger le document signé
Télécharger le document signé
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Document ID
|
Document ID | True | string |
ID de document à partir de l’action Chargement de document |
Retours
Contenu du document
- Contenu du document
- binary
Déclencheurs
| Attendre la signature du document |
Attendre la signature du document |
Attendre la signature du document
Attendre la signature du document
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de demande de signature
|
signatureRequestId | True | string |
ID de demande de signature de l’action de demande de signature |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
code
|
code | string |
code |
|
statusCode
|
statusCode | integer |
statusCode |
Définitions
binaire
Il s’agit du type de données de base "binaire".