Widgets und API
Nutzung der Nachhaltigkeitsampel
Die WeGreen Nachhaltigkeitsampel kann kostenlos in eigene Anwendungen und Portale integriert werden.
Beispiele für bereits erfolgte Integrationen sehen Sie auf unser Seite Apps.
Für die Integration stehen zwei Schnittstellen zur Verfügung:
- Die Javascript API erlaubt die Integration der Nachhaltigkeitsampel als Widget in Web-basierte Angebote mit minmalem Aufwand. Hierbei sind keine Programmierkenntnisse nötig.
- Die Webservice API erlaubt den direkten Zugriff auf die Datenbank von WeGreen und ist insbesondere für die Integration in Mobile Apps und Desktop Applikationen geeignet.
Javascript API
Die Integration der WeGren Nachhaltigkeitsampel als Widget erfolgt in zwei einfachen Schritten:
Schritt 1: Initialisierung der API
Fügen Sie bitte zunächst das folgende JavaScript vor dem schliessenden Body-Tag der Seite ein, auf der sie die Nachhaltigkeitsampel einblenden wollen:
Ersetzen Sie nach dem Einfügen die Zeichenkette $APP_ID durch Ihre Application ID und die Zeichenkette $LOCALE durch die gewüschte Sprachvariante. WeGreen unterstützt die Sprachvarianten de (Deutsch), fr (Französisch) und en (Englisch).
Hinweis: Die Initialisierung der JavaScript API von WeGreen erfolgt asynchron und verlangsamt nicht das Laden oder die Darstellung Ihrer Webseite.
Schritt 2: Platzierung des Widgets
Danach fügen gehen Sie zu der Nachhaltigkeitsampel die sie in Ihre Seite einfügen wollen und Klicken auf "Einbetten". Fügen Sie den angezeigten Tag an der Stelle in Ihre Webseite ein, an der die Nachhaltigkeitsampel erscheinen soll. Fertig!
Zum Beispiel fügt der Tag
Hinweis: Das Widget aktualisiert sich selbstständig. Wenn sich z.B. die Bewertung des Unternehmens oder die Anzahl der interessierten Nutzer verändert, wird dies automatisch auf Ihrer Webseite dargestellt!
Widget für Dynamische Webseiten
Wenn Sie die Nachhaltigkeitsampel in eine dynamische Webseite einfügen wollen, auf der je nach Aufruf unterschiedliche Unternehmen, Marken oder Produkte angezeigt werden, können Sie einen Tag einfügen, der automatisch die passende Nachhaltigkeitsampel findet. Fügen Sie dazu den folgenden Tag ein:
Ersetzen Sie nach dem Einfügen die Zeichenkette $LAYOUT durch die gewünschte Darstellungsvariante des Widgets. Es stehen die Varianten standard und link zur Verfügung.
Ersetzen Sie die Zeichenkette $SELECTOR durch die gewünschte Adressierung des Unternehmens, der Marke oder des Produkts, zu welchem die passende Nachhaltigkeitsampel dargestellt werden soll.
Zum Beispiel findet der nachfolgende Tag automatisch die Nachhaltigkeitsampel des Unternehmens, mit der angegebenen Homepage, im Link-Layout:
| Name | Funktionsweise | Wert |
|---|---|---|
| text | Selektion über einen bekannten Namen des Unternehmens, der Marke oder des Produkts | Z.B. "BASF SE" oder "basf" |
| href | Selektion über zugeordnete Homepage | Vollständige URL der Homepage, z.B. "http://www.basf.com/index.html". Bei der Suche wird nur die Domain berücksichtigt. |
| fid | Selektion über ID in der Freebase Datenbank | Z.B. "/en/basf" für das Unternehmen BASF SE |
Hinweis: Es können auch mehrere Tags auf einer Seite eingefügt werden, z.B. wenn Sie auf einer Seite Nachhaltigkeitsampeln zu verschiedenen Unternehmen, Marken oder Produkten darstellen wollen.
Webservice API
Für nicht HTML-basierte Anwendungen steht eine wahlweise HTTP/JSON oder HTTP/XML basierte REST API als Webservice zur Verfügung.
Kontaktieren Sie bitte support@wegreen.de um diese API freischalten zu lassen und eine Dokumentation zu erhalten.
Nutzungsbestimmungen und Application ID
Die Nutzung der WeGreen APIs ist kostenlos, unterliegt jedoch Nutzungsbestimmungen. Z.B. muss bei der Verwendung der Daten WeGreen als Urheber erkennbar sein.
Für die Nutzung der WeGreen APIs wird eine "Application ID", für die Webservice API zusätzlich ein "Application Secret" benötigt, das bei jedem Aufruf übermittelt werden muss. Die Application ID erlaubt uns die Zugriffe auf den WeGreen Datenbestand zu kontrollieren und bei unsachgemäßer Nutzung zu sperren.
Jeder registrierte Nutzer von WeGreen hat automatisch eine persönliche Application ID und ein Application Secret. Hierzu bitte einfach bei WeGreen über den grünen Knopf im Titel dieser Seite anmelden und im Bereich "Mein WeGreen" auf die Seite "Für Entwickler" navigieren.
Become a fan!