Développeurs d'enseignes OneSpan : Salle virtuelle - Partie 1

Duo Liang,

OneSpan Sign Virtual Room (VR) offre une expérience utilisateur sécurisée et interactive où les signataires et l'organisateur de la réunion peuvent collaborer par le biais d'une vidéoconférence et signer des documents dans le cadre d'une session de co-navigation à partir de différents endroits. Elle recrée la puissance d'une réunion en face à face en combinant la signature électronique, la vidéoconférence, la preuve d'identité, l'enregistrement de la session et les pistes d'audit.

L'ensemble du parcours de l'expérience comprend un processus simple en cinq étapes. Lorsque l'expéditeur prépare entièrement la transaction et fixe la date et l'heure de la séance de signature virtuelle, les destinataires sont invités par notification électronique. Une fois que les deux parties ont rejoint la salle virtuelle, les destinataires peuvent être invités à s'authentifier par le biais des méthodes sélectionnées, et l'hôte aidera les signataires à examiner et à comprendre l'accord en temps réel. Les signataires suivront un flux de travail intuitif et guidé et termineront la signature des documents.

Dans ce blog, nous allons nous plonger dans cette nouvelle fonctionnalité passionnante et montrer comment préparer une transaction de signature en salle virtuelle. Sans plus attendre, commençons !

La signature en salle virtuelle en action

Avant de lire le blog d'aujourd'hui, prenez quelques minutes pour regarder notre tutoriel vidéo étape par étape dans lequel nous avons montré comment préparer et configurer une transaction pour Virtual Room via l'interface utilisateur de l'expéditeur et comment lancer et signer une session Virtual Room en action réelle.

Remarque : la fonction Salle virtuelle est désactivée par défaut. Contactez notre équipe pour commencer à utiliser OneSpan Sign Virtual Room.

Meilleure pratique pour les utilisateurs intégrés

En ce qui concerne la préparation de la transaction, comme pour l'interface utilisateur, les intégrateurs peuvent également mettre en œuvre ce flux de travail via les API REST. Dans cette section, nous allons passer en revue les étapes nécessaires et souligner les différences par rapport à la création normale d'une transaction.

Étape 1 : Créer une transaction

La première étape consiste à déclencher la configuration de la salle virtuelle lors de la création d'une transaction normale et à laisser la transaction à l'état de "brouillon" à l'aide de l'API ci-dessous :

Requête HTTP

POST /api/packages

En-têtes HTTP

Authorization : Basic api_key / Bearer access_token
Accept : application/json
Content-Type : multipart/form-data

Exemple de charge utile

{
  "roles" : [
    {
      "id" : "Owner",
      "name" : "Propriétaire",
      "signers" : [
        {
          "email" : "email de l'expéditeur",
          "firstName" : "Duo",
          "lastName" : "Liang",
          "entreprise" : "OneSpan Sign",
          "id" : "Propriétaire"
        }
      ]
    },
    {
      "id" : "Signer1",
      "name" : "Signer1",
      "signers" : [
        {
          "email" : "[email protected]",
          "firstName" : "1.prénom",
          "lastName" : "1.Lastname",
          "entreprise" : "OneSpan Sign",
          "id" : "Signer1"
        }
      ]
    }
  ],
  "documents" : [
    {
      "approvals" : [
        {
          "role" : "Signer1",
          "fields" : [
            {
              "page" : 0,
              "top" : 100,
              "sous-type" : "FULLNAME",
              "height" : 50,
              "left" : 100,
              "width" : 200,
              "type" : "SIGNATURE"
            }
          ]
        }
      ],
      "nom" : "Document de test"
    }
  ],
  "nom" : "Exemple de paquet",
  "type" : "PACKAGE",
  "langue" : "en",
  "emailMessage" : "",
  "description" : "Nouveau paquet",
  "autocomplete" : true,
  "virtualRoom" : true,
  "status" : "DRAFT"
}

Remarque :

  • Ajoutez explicitement l'hôte de la salle virtuelle et spécifiez l'ID du rôle. Dans notre cas, l'hôte de la salle virtuelle est le propriétaire de la transaction, mais il peut s'agir de n'importe quelle adresse électronique à condition qu'elle ait un profil d'expéditeur OneSpan Sign.
  • N'oubliez pas d'activer le drapeau "virtualRoom" : true (vrai)

Étape 2 : Paramétrage de la salle virtuelle

L'étape suivante consiste à configurer les paramètres liés à la salle virtuelle, notamment l'activation des caméras pendant la session, l'autorisation de l'enregistrement vidéo et la spécification de l'ID de l'hôte, de l'heure de début et de la durée de la réunion. Ces paramètres peuvent être spécifiés via l'API ci-dessous :

Requête HTTP

PUT /api/packages/{packageId}/virtual-room/config

En-têtes HTTP

Authorization : Basic api_key / Bearer access_token
Accept : application/json
Content-Type : application/json

Exemple de charge utile

{
    "video" : true,
    "videoRecording" : false,
    "startDatetime" : "2022-02-14T03:14:00.000Z",
    "hostUid" : "Owner",
    "sessionTime" : 60,
    "sessionTimeoutWarning" : 15
}

Remarque :

  1. Convertissez l'heure de début de la session en heure GMT au format "yyyy-MM-dd'T'HH:mm:ss'Z'"
  2. Lorsque la date de début a été spécifiée et apparaîtra dans l'e-mail d'invitation envoyé à tous les participants à la réunion, les participants peuvent toujours organiser la réunion et y accéder à une autre date et heure.

Étape 3 : Envoyez la transaction

Demande HTTP

PUT /api/packages/{packageId}

En-têtes HTTP

Authorization : Basic api_key / Bearer access_token
Accept : application/json
Content-Type : application/json

Exemple de charge utile

{"status" : "SENT"}

Les fonctionnalités fonctionnent en tandem avec la RV

Lors de l'étape de préparation de la transaction, le propriétaire dispose d'options supplémentaires pour concevoir le flux de signatures. Il peut demander aux signataires de télécharger des pièces jointes au flux de travail, comme une copie de leur permis de conduire, et éventuellement d'authentifier l'identité du signataire avant qu'il ne soit autorisé à participer à la session. Le propriétaire de la transaction peut choisir parmi un certain nombre d'options d'authentification, telles que le courrier électronique, les SMS, les questions-réponses et la vérification de l'identité par le gouvernement avec comparaison des visages.

Ceci conclut le blog d'aujourd'hui. À présent, vous devriez être en mesure de créer une transaction de signature de salle virtuelle via l'API REST. Dans le prochain blog, j'expliquerai le flux de travail équivalent dans le code SDK et je présenterai d'autres fonctionnalités de la signature en salle virtuelle. Si vous avez des questions concernant ce blog ou tout autre sujet relatif à l'intégration de OneSpan Sign dans votre application, visitez les forums de la communauté des développeurs. Vos commentaires nous intéressent !