Fonction HTTP

🔌 Qu'est-ce qu'une fonction HTTP ?

La fonction de sécurité Http vous permet d'étendre facilement ngSurvey avec vos propres fonctions distantes REST HTTP.

En utilisant la fonction de sécurité HTTP, vous pouvez configurer une interface utilisateur personnalisée pour recueillir des données auprès du Répondant avant l'affichage du Sondage, envoyer ces données à un endpoint REST HTTP spécifique sous forme d'objet JSON simple, effectuer tout type de logique métier sur les données et renvoyer un nouvel objet JSON depuis votre endpoint HTTP qui sera stocké avec les réponses du Répondant et pourra être utilisé n'importe où dans le Sondage via les fonctionnalités de piping de ngSurvey.

☁️ Que sont envoyés et reçus ?

L'objet qui sera envoyé à votre endpoint HTTP par ngSurvey est un objet formaté en JSON simple comme suit

{
 properynamefromyouruserinterface1 : 'value', 
 properynamefromyouruserinterface2 : 'value'
}

En plus des valeurs de l'interface utilisateur saisies par le Répondant, ngSurvey envoie également les propriétés supplémentaires suivantes au endpoint :

{
 ngsSurveyId : 'abcd' // ID du Sondage, 
 ngsRemoteip : '127.0.0.1' // IP du Répondant
}

L'objet retourné par le endpoint HTTP doit être formaté en tant qu'objet JSON comme montré ci‑dessous ; vous pouvez renvoyer autant de propriétés que vous le souhaitez.

{
yourproperty1:'value', 
yourproperty2:'value'
}
circle-info

🧙 Les valeurs renvoyées par votre endpoint HTTP peuvent être piped utilisées n'importe où dans les textes de vos Questions ou dans les Réponses du Sondage en utilisant le format de pipe suivant __yourproperty1__

🔅 Propriétés de la fonction HTTP

  • URL du endpoint Http doit être l'URL http qui recevra les données saisies dans l'interface utilisateur. ngSurvey envoie les données soit en tant qu'objet JSON si configuré sur post, soit en tant que paires clé/valeur ajoutées à l'URL du endpoint.

  • Transférer les valeurs de requête si activé, ngSurvey transférera toutes les paires clé/valeur de la querystring qui ont été définies dans l'URL du Sondage.

  • Appeler au chargement La fonction Http sera immédiatement appelée une fois l'élément de sécurité chargé sans afficher l'interface utilisateur. Cela peut être utile si vous souhaitez utiliser le endpoint avec des paramètres de querystring sans demander d'informations via l'interface utilisateur.

  • Sécurisé let vous configurez un jeton JWT qui sera utilisé pour autoriser le endpoint http.

  • Nom de la propriété de valeur unique est le nom de la propriété de l'objet renvoyé par le endpoint Http qui sera utilisé comme « clé primaire » pour identifier de manière unique les données retournées. Cette clé unique sera utilisée pour empêcher les entrées en double et pour activer les fonctionnalités de sauvegarde/reprise si l'élément de sécurité Http est défini comme fournisseur de clé.

  • Chargement Petit message qui s'affichera pendant l'appel au chargement.

  • Message d'introduction Petit message qui sera affiché au-dessus de l'interface utilisateur.

Mis à jour

Ce contenu vous a-t-il été utile ?