Chaque fois qu’un nouvel événement se produit sur votre compte, Universign crée un événement. Un événement correspond à une modification d’une ressource avec laquelle vous avez interagi ou à l’utilisation que vous avez faite d’un service. Par exemple, si vous créez ou supprimez une clé API, un événement est déclenché tel que apikey.created ou apikey.deleted. Notez qu’Universign ne trace que les événements liés aux requêtes API ayant renvoyé un code de statut 200.
Accéder aux événements de votre espace de travail
Si votre compte dispose de droits API et si vous en êtes le propriétaire, ou si vous avez un rôle d’administrateur ou d’intégrateur, vous avez alors accès à un espace Développeur depuis votre espace de travail. Pour consulter les événements de votre espace de travail, accédez à la section Événements de l’espace Développeur.
La liste des événements webhookables est la suivante :
Événements de clé API
apikey.created(la clé API a été créée)apikey.updated(le nom de la clé API a été mis à jour)apikey.deleted(la clé API a été supprimée)
Événements de transaction
transaction.lifecycle.created(la transaction a été créée en brouillon)transaction.lifecycle.started(la transaction a été lancée)transaction.lifecycle.paused(la transaction a été mise en pause)transaction.lifecycle.cancelled(la transaction a été annulée)transaction.lifecycle.expired(la transaction a expiré)transaction.lifecycle.completed(tous les participants ont effectué leurs actions, la transaction est terminée et tous les documents signés sont prêts à être récupérés)transaction.chat.message.received(le créateur de la transaction a reçu un message instantané envoyé par le participant)
Événements d’action des participants
action.opened(l’action est prête à être effectuée par le participant)action.closed(le participant a effectué son action)action.stalled(le participant n’a pas effectué son action dans le délai imparti)action.manualreminder.sent(un rappel manuel a été envoyé au participant)action.reminder.sent(un rappel automatique a été envoyé au participant)action.waitingperiod.cancelled(la période d’attente a été annulée dans la transaction)action.waitingperiod.ended(la période d’attente est terminée et le participant peut maintenant effectuer son action)
Liste de toutes les raisons possibles de blocage
Notez qu’une action d’un participant peut être bloquée pour l’une des raisons suivantes :
action_refusal: le participant a refusé de s’authentifier sur la page de signaturesignature_refusal: le participant a refusé de signer un documentconsultation_refusal: le participant a refusé de consulter un documentreview_refusal: le participant a refusé de réviser un documentupload_refusal: le participant a refusé de télécharger des documents justificatifsunknown_editor: le co-éditeur est inconnuedition_refusal: le co-éditeur a refusé de remplir les informations du participant inconnuactor_conflict: une relation cyclique apparaît dans la transactionincorrect_name_prerequisite: le participant a refusé le nom prérequisincorrect_mobile_prerequisite: le participant a refusé le numéro de téléphone prérequisincorrect_information_prerequisite: le participant a refusé le nom et le numéro de téléphone prérequissealer_expired: le certificat lié au scelleur est expiré
La raison du blocage est indiquée dans la charge utile de l’événement action.stalled.
Événements de validation d’identité
identity-validation.processed(l’identité a été vérifiée)
Événements d’enregistrement
| Événement | Description |
registration.identity.verified |
L’identité a été vérifiée avec une valeur verification_status parmi success ou failure. |
registration.identity.rejected |
L’identité validée a été rejetée. L’utilisateur a déclaré une erreur dans ses données extraites et présentées comme valides. Ce rejet peut être dû à une erreur d’extraction ou à une erreur de saisie dans le fichier d’enregistrement des données. |
registration.lifecycle.rejected |
Les informations d’identité ont été rejetées au début du processus si l’une des exigences d’enregistrement spécifiées par le créateur de l’enregistrement n’est pas respectée (par exemple, nom complet de l’utilisateur et/ou numéro de téléphone). |
registration.lifecycle.expired |
La session d’enregistrement a expiré. Notez qu’un enregistrement a une durée de vie de 7 jours. Après cette période, s’il n’a pas été utilisé pour créer un certificat, il est supprimé. |
registration.lifecycle.completed |
L’enregistrement est terminé : l’utilisateur a choisi un nom de certificat et signé l’accord d’abonnement. |
registration.certificate.activated |
Le certificat a été émis et est prêt à être utilisé. |
Événements d’archivage
archiving.document.created(Une sous-tâche d’archivage (ex :ard_azObY3ozJeYn) a été créée pour archiver un document dans votre coffre-fort électronique. Une sous-tâche d’archivage est créée pour chaque document à archiver.)archiving.document.started(Le document a été envoyé vers votre coffre-fort électronique.)archiving.document.archived(Le document a été archivé dans votre coffre-fort électronique.)archiving.task.created(Une tâche d’archivage (ex :art_JDgGP1eanQ3W) a été créée. Une seule tâche est créée par transaction.)archiving.task.finished(Tous les documents liés à la tâche d’archivage sont archivés dans votre coffre-fort électronique.)
Filtrer les événements de votre espace de travail
Une recherche d’événements renvoie tous les événements correspondant à vos filtres d’entrée. Si aucun résultat ne correspond à votre recherche, cela vous est indiqué.
- par période : Sélectionnez le format de recherche pour la période, soit Avant une date spécifique soit Entre deux dates spécifiques et entrez une valeur de recherche,
- par type : Cela fait référence au nom de la ressource ou du service avec lequel vous avez interagi,
- par clé API : Sélectionnez la clé API qui a été utilisée pour authentifier les requêtes.
Notez que vous pouvez exporter la liste des événements correspondant à votre recherche au format CSV.
Afficher les informations sur un événement spécifique
Cliquez sur un événement pour afficher ses informations détaillées.
Chaque événement comprend :
- une enveloppe contenant des données sur l’événement lui-même,
- le corps de la réponse renvoyée par l’API.
Récupérer le rapport de consommation
Vous pouvez avoir besoin de récupérer des informations utiles sur votre consommation au sein des services d’Universign.
Cet endpoint vous permet de calculer et de récupérer le rapport de consommation de votre espace de travail sur une certaine période pour plusieurs actions telles que :
- transactions (par statut),
- signatures (par niveau),
- documents signés et/ou lus,
- visas,
- scellés,
- révisions,
- horodatages,
- identités (par statut de vérification),
- certificats créés.
Pour récupérer un rapport de consommation de l’espace de travail, envoyez une requête à GET /v1/consumptions/summary :
curl
https://api.universign.com/v1/consumptions/summary?created_gt=2022-12-19T00:00:00Z&created_lt=2024-01-19T00:00:00Z
Notez que vous pouvez toujours récupérer le rapport de consommation en envoyant une requête à GET /v1/events/report. Cependant, cet endpoint est déprécié.
L’API renvoie un objet events-report.
{
"object": "events-report",
"tenant_id": "wsp_JqqOX1OY778L",
"started_transactions": 895,
"completed_transactions": 695,
"cancelled_transactions": 100,
"expired_transactions": 100,
"visas": 60,
"read_documents": 60,
"seals": 2436,
"sealed_documents": 87,
"reviews": 154,
"captures": 56,
"signatures": 511,
"signed_documents": 383,
"signatures_by_required_level": {
"level_3": 6,
"level_4": 4,
"level_0": 5,
"level_1": 452,
"level_2": 44
},
"signed_documents_by_required_level": {
"level_3": 6,
"level_4": 4,
"level_0": 4,
"level_1": 325,
"level_2": 44
},
"transactions_by_max_level": {
"level_3": 3,
"level_4": 2,
"level_0": 2,
"level_1": 150,
"level_2": 22
},
"timestamps": 1,
"rfc3161_timestamps":11,
"total_timestamps":12,
"standalone_seals": 28,
"pvid_identities_analysed": 9,
"pvid_identities_validated": 5,
"pvid_identities_rejected": 4,
"certificate_creation_with_pvid": 3,
"web_identities_analysed": 51,
"web_identities_validated": 38,
"web_identities_rejected": 13,
"certificate_creation_with_web": 9
}
