Die ProvenExpert-API : die Basics

In diesem Artikel möchte ich Ihnen unsere API (Programmierschnittstelle) vorstellen. Eine API ist ein gängiges Mittel zum Austausch von Daten zwischen Online-Diensten oder z.B. mobilen Anwendungen. Auch ProvenExpert nutzt diese Schnittstelle. Die nachfolgende Einführung richtet sich sowohl an Produktverantwortliche als auch an die Entwickler und zeigt, wie man die API einbindet.

Was kann die API?

Die API bietet die Möglichkeit zum Austausch von Daten zwischen ProvenExpert und einer anderen Anwendung, zum Beispiel Ihrem Online-Shop oder Ihrer Kundenverwaltung. Damit lassen sich durch Programme automatisiert Funktionen nutzen, auf die man sonst durch die Nutzung des Portals im Browser zugreift. Als erste Funktion haben wir die Erstellung von Einladungs-Links zu Umfragen in die API aufgenommen.

Wofür kann man die API einsetzen?

Die Links zu Umfragen, die Sie mit der API erstellen können, lassen sich beispielsweise in den Bestellprozess eines Online-Shops integrieren. So können Sie von Kunden, die gerade einen Artikel gekauft haben, direkt Feedback einholen, indem Sie den Einladungs-Link in Ihrer Bestätigungsemail platzieren. Durch die Nutzung des Links wird die Bewertung des Kunden automatisch als verifiziert angesehen, was die Abgabe des Feedbacks für Ihren Kunden vereinfacht. Auch bei der Nutzung der API gelten unsere Datenschutzbestimmungen. Das heißt, die angegebenen Daten wie E-Mail-Adresse oder Namen werden ausschließlich zur Einladung der Nutzer eingesetzt.

Verwendung der API

Um auf die API zuzugreifen, benötigen Sie einen API-Schlüssel. Diesen können Sie auf der entsprechenden Seite, die Sie ganz unten auf der Einstellungsseite finden, erstellen. Sie können den Schlüssel jederzeit neu erstellen. Mit Ihrem API-Nutzernamen und dem API-Schlüssel, welche Sie auf der Seite Personalisierte Umfragelinks (API) finden können Sie auf die API zugreifen.

Welche Informationen werden benötigt?

Die Felder email und code sind Pflichtfelder. email ist dabei die E-Mail-Adresse des Kunden und code ist der Zugangscode zur Umfrage, den Sie auf der Umfrageseite finden.

code von Umfrageseite entnehmen

Optional können die Felder firstname, lastname, name und relation gesetzt werden, diese werden dann bei der Abgabe der Bewertung in die entsprechenden Formularfelder eingesetzt. Außerdem werden die Namen auch in der Liste der Einladungen auf der Umfrageseite angezeigt.

Liste mit den verschickten Einladungen

Weiterentwicklung und Wünsche

Wir werden in der Zukunft weitere nützliche Funktionen in der API ergänzen. Wenn Sie Fragen zum Thema haben oder bestimmte Funktionen wünschen, schreiben Sie uns einfach. Wir freuen uns auf Ihr Feedback. Hier gibt es noch mal eine kompakte Zusammenfassung zur ProvenExpert-API als PDF-Datei.