Interactivités: documentation pour le développeur:Protocole Enquêter

Un article de ScriptdigitalWiki.

Jump to: navigation, search

Inscription des moteurs d'interactivités - Protocole Voter - Protocole Enquêter - Protocole Justifier


Sommaire

Protocole Enquêter

Un protocole pour permettre à un client Flash d'envoyer un texte à un serveur et de recevoir en retour, après validation du client auprès du serveur, les n derniers textes envoyés au serveur dans le cadre d'un cours spécifique.

Pour interpeller le serveur, le Flash peut utiliser deux modes qui sont passés avec des variables dans l'URL qui pointe vers le script permettant au serveur de retourner une réponse aux requêtes des Flash.Dans les deux cas, l'URL contenue dans la variable urlClientFlash permet de vérifier si la ressource Flash est inscrite auprès du serveur.

  • (1) mode=statusclient
  • (2) mode=insere
   Exemple d'une requête du client Flash avec le mode statusclient:
       
       [client Flash]
       GET /enquêter.php?mode=statusclient&urlClientFlash=http%3A%2F%2Fexample.com%2FleFlash.swf
       
       [serveur]
       HTTP/1.1 200 OK
       Content-type: application/x-www-urlform-encoded
       
       status=ok // la ressource Flash est bien enregistrée


mode statusclient

Le premier mode 'statusclient' permet de vérifier que la ressource Flash est bien inscrite auprès du serveur. Au préalable, la ressource Flash aura été inscrite via l'interface Web administrative. <http://example.org/www/servicesweb2/sites/admin/adm_investigation1.php>

L'URL vers laquelle le Flash client doit pointer est (temporairement) celle-ci: <http://example.org/www/servicesweb2/sites/investigation1/message.php>

Exemple

   GET /enquêter.php?mode=statusclient&urlClientFlash=http%3A%2F%2Fexample.com%2FleFlash.swf
   => le serveur répond avec le fragment suivant:
   
       Content-type: application/x-www-urlform-encoded
       
       status=ok // la ressource Flash est bien enregistrée
       
       ou
       
       status=nok // la ressource Flash n'est pas enregistrée

mode insere

Le second mode 'insere' permet au serveur d'ajouter un texte passé en POST par le client Flash dans la variable 'texte_1' à la file des textes existants dans sa banque de données et de retourner les n derniers textes dans un format structuré au format application/x-www-urlform-encoded.

Exemple

   POST /enquêter.php?mode=insere&urlClientFlash=http%3A%2F%2Fexample.com%2FleFlash.swf
   Content-type: application/x-www-form-urlencoded
   
   texte_1           =   ceci+est+une+r%C3%A9ponse

Le serveur retournera (le contenu de la variable 'reponses' doit être urlencodé, ce qui n'est pas le cas dans cet exemple):

    status      =   ok&
    reponses    =   <p><b>14/01/2006 10:22:27 AM</b></p><p>ceci est un réponse</p>
    
    <p><b>14/01/2006 10:20:07 AM</b></p><p>une autre réponse</p>
    
    <p><b>14/01/2006 07:34:23 AM</b></p><p>encore une réponse</p>
    etc.

Le format texte de la variable 'reponses'

Le format du texte renvoyé par le serveur et contenu dans la variable 'reponses' est défini dans un fichier de configuration central. Pour l'instant, on ne peut changer le format à cause de la compatibilité avec d'autres Flash entrés en fonction antérieurement. Une prochaine version du protocole devrait donner l'option de définir le format du texte qui sera retourné par le serveur, ce qui permettrait de renvoyer du XML.