Aller au contenu
Créer un sondage
Simpoll / API

Guide de l’API Simpoll

Guide du développeur de l’API Simpoll : transmettre vos propres paramètres à un sondage, recevoir les réponses sur votre site par POST, GET ou JavaScript et vérifier les signatures.

Sommaire

Guide de l’API Simpoll

  1. 1Introduction
  2. 2Réglages du sondage
  3. 3Recevoir les résultats
  4. 4Callback JavaScript
  5. 5Transmettre des paramètres
  6. 6Signature

1.1. Introduction

L’API Simpoll relie votre site à n’importe quel sondage Simpoll de plusieurs façons. Son rôle principal est d’envoyer les résultats du sondage à votre site pour que vous les traitiez.

Avec l’API, vous pouvez :

  • associer les répondants aux visiteurs de votre site ;
  • savoir quels visiteurs ont rempli le sondage ;
  • savoir comment un visiteur a réussi un quiz (réussi ou non) ;
  • obtenir les réponses qu’un visiteur a données dans le sondage.

1.2. Fonctionnement

Le déroulement est le suivant :

  1. Lorsque vous intégrez un sondage sur votre site, vous pouvez lui transmettre des paramètres supplémentaires (par exemple un identifiant d’utilisateur) ;
  2. L’utilisateur remplit le sondage dans le cadre Simpoll ;
  3. À la fin du sondage, Simpoll appelle l’URL de résultats de votre site et renvoie les paramètres reçus de votre part (s’il y en a) ;
  4. En plus de vos paramètres, Simpoll envoie les résultats du sondage à l’URL de résultats.

En plus de livrer les résultats, un sondage peut donc servir de « proxy » pour n’importe quelles données à vous.

Les paramètres peuvent être envoyés à l’URL de résultats de trois façons :

Méthode POST

Les données sont envoyées en arrière-plan, sans que l’utilisateur le voie et sans passer par son navigateur. La requête part quand l’utilisateur clique sur « Envoyer » à la dernière page du sondage.

Méthode GET

Le navigateur de l’utilisateur est redirigé de la dernière page du sondage vers l’URL de résultats, avec les données ajoutées en paramètres GET. Dans ce mode, le réglage « Redirection après le sondage » est ignoré.

Appel d’une fonction JavaScript sur votre page

Vos paramètres et les résultats du sondage sont transmis à une fonction JavaScript de la page où le sondage est intégré. La fonction a un nom fixe et un argument : un objet contenant vos paramètres et les résultats du sondage.

Cette méthode fonctionne dans tous les navigateurs modernes.

1.3. Sécurité de la transmission

L’API Simpoll peut signer les données qu’elle reçoit et envoie. Les signatures sont facultatives, mais elles garantissent que personne ne modifie les données en chemin.