OneSpan Sign Developer: Custom Fields - Partie 2

Duo Liang, avril 15, 2020

OneSpan Sign Developer: Custom Fields – Part 2

"Custom Fields" est une caractéristique puissante lors de la définition de champs de liaison supplémentaires pour vos expéditeurs et de leur référence lors de la conception des transactions. Ces champs personnalisés stockent généralement des informations fixes qui sont téléchargées par l’expéditeur une fois et référencées à plusieurs endroits. Cela évite de forcer l’expéditeur à saisir manuellement les informations à chaque fois lors de la signature.

Dans le blog précédent, nous avons passé en revue la façon de définir un champ personnalisé et les valeurs d’entrée de la vue de chaque expéditeur à partir du portail de l’interface utilisateur. Nous allons prendre dès là et discuter de la façon dont vous pouvez tirer parti des fonctions SDK ou les API pour s’intégrer à cette fonctionnalité. Commençons !

Décrivez Custom Fields

En plus de créer des champs personnalisés directement à partir de l’interface utilisateur, OneSpan Sign expose également l’API vous permettant de créer, modifier, interroger et supprimer les définitions personnalisées du champ.

4-15-1
Explorez notre guide «Custom Fields» pour obtenir des instructions détaillées et des codes d’échantillons pour les approches REST API et SDK.

Mettre à jour les valeurs personnalisées de champ d’expéditeur

Dans le cas où vous souhaitez fournir votre propre interface utilisateur pour collecter ces valeurs de champ personnalisées ou les valeurs sont chargées à partir de la base de données, vous pouvez utiliser l’API mise à jour de l’expéditeur et insérer ces valeurs programmatiquement.

Vérifions d’abord le schéma "Sender". Les champs personnalisés sont hébergés au nœud "userCustomFields" avec les champs requis de "id" et "valeur". Ainsi, vous organiseriez vos demandes d’API en tant que telles :

Demande HTTP

POST /api/account/senders/senderID

En-têtes HTTP

Accepter : application/json

Demande de charge utile

{
  "userCustomFields": [
    {
      "id": "agent_number_id",
      "valeur": "valeur de l’expéditeur du numéro d’agent"
    },
    {
      "id": "policy_number_id",
      "valeur": "valeur de l’expéditeur du numéro de police"
    }
  ]
}

Récupérer les valeurs personnalisées de champ d’expéditeur

Pour tirer les valeurs programmatiquement, invoquez une demande GET et passez par le nœud « userCustomFields » de l’entité de réponse.

Demande HTTP

GET /api/account/senders/senderID

En-têtes HTTP

Accepter : application/json

Charge utile de réponse

{
  "société": "OneSpan",
  "timezoneId": "America/Detroit",
  "email": "[email protected]",
  "firstName": "Duo",
  "lastName": "Liang",
  "langue": "en",
  "userCustomFields": [
    {
      "id": "agent_number_id",
      "données": nul,
      "traductions": [
        {
          "description": "",
          "langue": "en",
          "id": "",
          "données": nul,
          "nom": "Numéro d’agent"
        }
      ],
      "valeur": "valeur de l’expéditeur du numéro d’agent",
      "nom": ""
    },
    {
      "id": "policy_number_id",
      "données": nul,
      "traductions": [
        {
          "description": "",
          "langue": "en",
          "id": "",
          "données": nul,
          "nom": "Numéro politique"
        }
      ],
      "valeur": "valeur de l’expéditeur du numéro de police",
      "nom": ""
    }
  ],
  ......
}

Ci-dessous le code de l’échantillon pourrait être utile si vous développez avec .NET:

        public IDictionary GetSenderCustomFieldValue (api_key de cordes, api_url de cordes, senderId de cordes),string>
            HttpClient myClient '  nouveau httpClient();
            myClient.DefaultRequestHeaders.Add ("Autorisation", "Basic" api_key);
            myClient.DefaultRequestHeaders.Add("Accept", "application/json");

            var senderResponse - myClient.GetAsync (nouveau Uri(api_url ' "/compte/senders/" ' senderId)). Résultat;

            si!senderResponse( . IsSuccessStatusCode)
                jeter nouvelle exception (senderResponse.Content.ReadAsStringAsync(). Résultat);
            }

            Résultat idictionnaire - nouveau dictionnaire();,> ,>
            JObject senderJSON - JObject.Parse (senderResponse.Content.ReadAsStringAsync(). Résultat);
            JArray userCustomFields (JArray) senderJSON["userCustomFields"];

            foreach (élément var dans userCustomFields)
                id de chaîne (corde) article["id"];
                valeur de la chaîne (corde)article[«valeur»];
                Résultat. Ajouter (id, valeur);
            }
      
            résultat de retour;
        }

Caractéristiques accompagnant les champs personnalisés

Si vous souhaitez sceller les valeurs personnalisées sur le terrain au certificat de signature ou ajouter les valeurs aux pistes d’audit, une solution réalisable consiste à utiliser la fonction Champs de session. Cela vous permet de stocker des données supplémentaires dans le résumé des preuves lors de la création d’une session de signature.

Voilà. Les sections ci-dessus doivent suffire à s’intégrer à la fonction de champ personnalisée. Si vous avez des questions concernant ce blog ou toute autre chose concernant l'intégration de OneSpan Sign dans votre application, visitez les Forums communautairesdes développeurs . Vos commentaires sont importants pour nous!