1.1. Einführung
Die Simpoll-API verbindet Ihre Website auf mehrere Arten mit jeder Simpoll-Umfrage. Ihre Hauptaufgabe ist es, Umfrageergebnisse zur weiteren Verarbeitung an Ihre Website zu senden.
Mit der API können Sie:
- Befragte den Besuchern Ihrer Website zuordnen;
- herausfinden, welche Besucher die Umfrage ausgefüllt haben;
- herausfinden, wie ein Besucher in einem Quiz abgeschnitten hat (bestanden oder nicht);
- die Antworten erhalten, die ein Besucher in der Umfrage gegeben hat.
1.2. Ablauf
Der Ablauf sieht so aus:
- Wenn Sie eine Umfrage auf Ihrer Website einbetten, können Sie ihr beliebige zusätzliche Parameter übergeben (zum Beispiel eine Benutzer-ID);
- Der Benutzer füllt die Umfrage im Simpoll-Rahmen aus;
- Nach Abschluss der Umfrage ruft Simpoll die Ergebnis-URL auf Ihrer Website auf und sendet die Parameter zurück, die es von Ihnen erhalten hat (falls vorhanden);
- Zusammen mit Ihren Parametern sendet Simpoll die Umfrageergebnisse an die Ergebnis-URL.
Neben der Übermittlung der Ergebnisse kann eine Umfrage also als „Proxy“ für beliebige Ihrer Daten dienen.
Parameter können auf eine von drei Arten an die Ergebnis-URL gesendet werden:
POST-Methode
Die Daten werden im Hintergrund gesendet, für den Benutzer unsichtbar und ohne seinen Browser. Die Anfrage wird gesendet, wenn der Benutzer auf der letzten Seite der Umfrage auf „Absenden“ klickt.
GET-Methode
Der Browser des Benutzers wird von der letzten Seite der Umfrage auf die Ergebnis-URL weitergeleitet, die Daten werden als GET-Parameter angehängt. In diesem Modus wird die Einstellung „Weiterleitung nach der Umfrage“ ignoriert.
Aufruf einer JavaScript-Funktion auf Ihrer Seite
Ihre Parameter und die Umfrageergebnisse werden an eine JavaScript-Funktion auf der Seite übergeben, in die die Umfrage eingebettet ist. Die Funktion hat einen festen Namen und ein Argument: ein Objekt mit Ihren Parametern und den Umfrageergebnissen.
Diese Methode funktioniert in allen modernen Browsern.
1.3. Sicherheit der Datenübertragung
Die Simpoll-API kann die empfangenen und gesendeten Daten signieren. Signaturen sind optional, garantieren aber, dass niemand die Daten unterwegs verändert.