LamaPoll-API nutzen

Was kann die API v2 und wofür können Sie sie verwenden?

Wie viel einfacher wäre Ihre Arbeit, wenn Sie sämtliche Statistiken, Rohdaten und Ergebnisse Ihrer Umfragen automatisiert erhalten oder mit Ihrem CRM-System verknüpfen? Und stellen Sie sich vor, Sie könnten nicht nur Teilnehmerimporte, sondern auch die Arbeit mit dem LamaPoll-Adressbuch ganz automatisch optimieren? Das geht bereits! Alles, was Sie dafür brauchen, ist unsere API v2. Im Folgenden erklären wir Ihnen genauer, welche Vorteile die Programmierschnittstelle mit sich bringt und wie Sie diese effizient nutzen. Zudem erfahren Sie alles zum API-Key-Management - vom Generieren über Sicherheitsmaßnahmen bis hin zum Löschen.

Das Akronym API steht für Application Programming Interface. Dabei handelt es sich um eine Programmierschnittstelle, die genutzt wird, um Daten zwischen einer Software und anderen Programmteilen nach einer festen Struktur auszutauschen. Der Austausch findet dabei auf Quelltext-Ebene statt. Kurz gesagt: Mit einer API ermöglichen Sie die Kommunikation verschiedener Systeme miteinander. Genaues zur Dokumentation unserer REST-API finden Sie hier: LamaPoll API v2 Dokumentation.

Wenn Sie sich genauer mit der API v2 befassen, wird Ihnen auffallen, dass es bereits eine API v1 gab. Dabei handelt es sich um die Vorgänger-Version der API v2, die veraltet und entsprechend nicht mehr auf dem neuesten Stand ist. Alle beschriebenen Features und Verwedungszwecke beziehen sich im Folgenden daher auf die aktuelle LamaPoll-API v2. 

• 1. Verknüpfung mit LamaPoll-Adressbuch    
• 2. Rohdaten, Auswertung & Ergebnisse per API abrufen
• 3. Mit welchen Systemen lässt sich die LamaPoll-API verbinden?
• 4. API-Key-Management: Sicherheitshinweise, Generieren & Löschen    
• 4.1 Wie erzeugt man einen API-Key? 
• 4.2 Zugriffsrechte des API-Keys  
• 4.3 Sicherheit & Gültigkeit    
• 4.4 Löschen oder Widerrufen eines API-Keys
• 4.5 Sicherheitshinweise & Notfallmaßnahmen 

1. Verknüpfung mit dem LamaPoll-Adressbuch

Über das Adressbuch haben Sie die Möglichkeit, sämtliche Teilnehmer Ihrer Umfrage einzuladen. Dort können Sie die Teilnehmerliste abspeichern und sowohl Namen, E-Mail-Adressen sowie Attribute hinterlegen und sämtliche Inhalte verwalten. Statt Ihr Adressbuch manuell oder mit einer CSV-Datei zu befüllen, können Sie diesen Schritt auch automatisieren. 

Verknüpfen Sie zum Beispiel Ihr Kundenmanagement-System (CRM) mit dem LamaPoll-Adressbuch. Daraus ergeben sich folgende Vorteile für Sie:

• Teilnehmerimport aus CSV-Datei via API
• Adressbuchexport via API
• Adressbuch durchsuchen via API

Die LamaPoll-API hilft Ihnen also damit, den Versand von Umfrageeinladungen zu automatisieren und so zu optimieren. Auch das automatische Hinzufügen oder Entfernen von Teilnehmern lässt sich mit der API v2 bewältigen. Gerade für Unternehmen und Nutzende, die mit großen und wechselnden Teilnehmerlisten diverser Umfragen agieren, ist der Mehrwert in puncto Zeitersparnis nicht zu unterschätzen. 

2. Rohdaten, Auswertung & Ergebnisse per API abrufen

Ein großer Part jeder Online-Befragung stellt die anschließende Auswertung der Daten dar. Im LamaPoll-Tool haben Sie selbstverständlich die Option, sich sämtliche Rohdaten, Gesamtergebnisse oder Charts zu exportieren beziehungsweise herunterzuladen. Setzen Sie jedoch auf unsere API v2, können Sie sich Ihren Ergebnisexport automatisiert ziehen und in Ihr CRM-System importieren. Das bedeutet für Sie im Detail:

• sämtliche Ergebnisse in aggregierter Form erhalten
• alle Fragen können per API gezogen werden
• Rohdatenexport möglich
• Filtermöglichkeit per API
• einstellbare Reporting- und Monitoring-Funktion
• Statistiken komplett abrufbar
• alle Ergebnisse sämtlicher Fragen automatisiert verfügbar

Wie rufe ich die Ergebnisse aller Fragen per API ab?

Um die Ergebnisse aller Fragen abzurufen, brauchen Sie die folgende Route /polls/{pollId}/results. Einmal eingerichtet, erhalten Sie anschließend die Häufigkeit aller Ergebnisse in absoluter und relativer Form. Zudem stehen Ihnen die Statistiken pro Skala, Gruppe sowie pro Block (zum Beispiel bei Matrixfragen) zur Verfügung. Sie benötigen die benutzerdefinierten Gewichtungen und Punkte? Über die bereits genannte Route haben Sie selbstverständlich auch die Möglichkeit, sich die Häufigkeiten und Ergebnisse exportieren zu lassen. 

Ferner stehen Ihnen alle Metadaten unabhängig der Frageart im gleichen Datenformat zur Verfügung. Dazu zählen unter anderem Beschriftungen, Gewichtungen und Punkte für Gruppen, Fragetexte und benutzerdefinierte Werte. 

Damit Sie sich die Ergebnisse aller Fragen per LamaPoll-API v2 exportieren lassen können, benötigen Sie die folgende Route: /polls/{pollId}/results

Das Autmatisieren Ihrer Umfrage-Ergebnisse bringt Ihnen nur Vorteile. Zum einen stehen Ihnen jederzeit aktuelle Daten für Ihr internes Reporting zur Verfügung, zum anderen können Sie sämtliche Inhalte unkompliziert für Präsentationen oder für Ihr Monitoring nutzen. Da sich alle Umfrage-Ergebnisse in die gängigen CRM-Systeme importieren lassen, haben Sie in einem zweiten Schritt die Option, Ihre Ergebnisdaten einem speziellem Analyse-Tool oder einem Data-Warehouse bereitzustellen. 

3. Mit welchen Systemen lässt sich die LamaPoll-API verbinden?

Die LamaPoll-API soll in erster Linie eins machen: Ihre Arbeit mit unserem Tool durch Automatisierung vereinfachen. Damit Sie sich diesen Vorteil zunutze machen können, funktioniert unsere API universell. Mit anderen Worten: Egal, ob Sie die LamaPoll mit SAP, Salesforce, HubSpot oder einer anderen Software verknüpfen wollen - unsere API v2 lässt sich problemlos mit Ihrem System verbinden. 

4. API-Key-Management: Sicherheitshinweise, Generieren & Löschen

Ein API-Key (Application Programming Interface Key) ist ein eindeutiger Code, den Sie benötigen, um sich bei einer API zu authentifizieren. Auf diesem Weg stellen Sie sicher, dass nur authorisierte Benutzer Zugriff auf bestimmte Daten und Funktionen haben. Besonders nützlich sind API-Keys für die Integration externer Anwendungen und Dienste mit unserer Plattform.

4.1 Wie erzeugt man einen API-Key?

Um einen API-Key zu erzeugen, folgen Sie diesen drei Schritten:

• Melden Sie sich mit Ihrem Benutzerkonto bei LamaPoll an.
• Navigieren Sie oben rechts zum Kontobereich und wählen API unter den Menüpunkten aus.

Abb.1 - LamaPoll-API als Menüpunkt im Kontobereich auswählbar

• Klicken Sie auf "neu generieren" und der neue API-Key wird Ihnen nun angezeigt.

Abb.2 - API-Key neu generieren im Menüpunkt API des Kontobereichs 

4.2 Zugriffsrechte des API-Keys

Ein erstellter API-Key hat exakt die gleichen Zugriffsrechte wie der Benutzer, der den Key generiert hat. Das bedeutet, dass der API-Key auf die Daten und Funktionen zugreifen kann, die auch der Benutzer selbst einsehen und verwenden kann. Daher ist es wichtig, API-Keys nur für vertrauenswürdige Anwendungen zu nutzen und diese auch nicht weiterzugeben.

4.3 Sicherheit & Gültigkeit

API-Keys laufen nicht ab. Sie behalten so lange ihre Gültigkeit, bis Sie diese bewusst neu generieren. Planen Sie einen Wechsel oder Austausch einer Anwendung, die bereits einen API-Key nutzt, empfehlen wir Ihnen im Zuge dieser Umstellung, diesen auch neu zu generieren. Der alte API-Key wird so ungültig und hat keinen Zugriff mehr auf das System. 

4.4 Löschen oder Widerrufen eines API-Keys

Um einen API-Key zu löschen oder zu widerrufen, müssen Sie einen neuen Key generieren. Und damit Sie den API-Key erneuern können, gehen Sie wie folgt vor:

• Stellen Sie sicher, dass Sie bei LamaPoll eingeloggt sind.
• Navigieren Sie innerhalb Ihres Kontobereichs zum Menüpunkt API. (siehe Abb.1)
• Klicken Sie auf "neu generieren". (siehe Abb.2)
• Sobald ein neuer API-Key generiert wurde, hat die API sofort keinen Zugriff mehr auf die Plattform.

4.5 Sicherheitshinweise & Notfallmaßnahmen

a) Was tun, wenn Sie glauben, jemand Fremdes hat Zugriff auf Ihren API-Key?

• Erneuern Sie den betroffenen API-Key sofort, um den Zugriff zu unterbrechen und aktualisieren Sie die betroffenen Anwendungen.
• Überprüfen Sie die Aktivitäten Ihres Benutzerkontos und ändern gegebenenfalls Ihre Zugangsdaten. 

b) Was tun, wenn Sie den API-Key "verloren" haben?

• Wenn Ihr API-Key nicht mehr auffindbar ist, loggen Sie sich einfach in Ihr Benutzerkonto ein. Dort ist er jederzeit einsehbar.
• Erstellen Sie gegebenenfalls einen neuen API-Key und aktualisieren dann die betroffenen Anwendungen.

c) Weitere Sicherheitsmaßnahmen

• Bewahren Sie Ihre API-Keys an einem sicheren Ort auf und teilen Sie diese niemals öffentlich.
• Überprüfen Sie die aktiven API-Keys und deren Nutzung regelmäßig.
• Setzen Sie zusätzliche Sicherheitsmaßnahmen wie IP-Whitelisting oder Zugriffsbeschränkugen für besonders kritische Anwendungen ein.

Starten Sie Ihre Umfrage jetzt kostenfrei!

Sie brauchen lediglich eine E-Mail-Adresse und ein Passwort

nach oben