Bei einigen Schnittstellen ist es erforderlich, einen sog. API-Key, eine Listen- und/oder Formular-ID zu hinterlegen. Mit diesen Informationen wird die Verknüpfung zwischen Schnittstelle und CleverReach hergestellt. Für die Nutzung der Schnittstellen Magento, Veyton, Shopware und Wordpress z. B. sind diese Keys zwingend erforderlich.
Erstellung/Ermittlung des API-Keys
Sie können diese Informationen direkt in Ihrem Account abrufen. Gehen Sie dazu auf oben rechts auf das Profil-Icon, klicken Sie dann auf [Mein Account] > [Extras] > [SOAP API]. Haben Sie noch keinen API-Key erstellt, müssen Sie zunächst einen API-Key mit entsprechender Berechtigung hinterlegen. Klicken Sie auf [API Key erstellen] und tragen Sie die Daten ein.
| Verwendungszweck: | einfacher interner Name zur Verwaltung |
| Zugriffsrechte: | Berechtigung des Keys ("Lesen und Schreiben" oder "Nur Lesen") |
Sie können den erstellten API-Key nun kopieren und in der entsprechenden Schnittstelle eintragen.
Ermittlung Listen-ID
Die Listen-ID entspricht der eindeutigen ID der jeweiligen Empfängergruppe. Sie finden die Listen-ID in den allgemeinen Einstellungen der Empfängergruppe unter [Einstellungen] > [Allgemeines].
Ermittlung Formular-ID
Jedes Formular verfügt über eine eindeutige ID, mit welcher Sie z. B. das Double-Opt-In über Schnittstellen auslösen können (je nach Schnittstelle). Sie finden die Formular-ID in den allgemeinen Einstellungen des Formulars unter [Einstellungen] > [Informationen].
Wichtige Hinweise:
- Der erstellte API-Key ist für den gesamten Account gültig. Wenn Sie also mehrere Schnittstellen ansprechen möchten (z. B. Shopsystem und Wordpress), brauchen Sie nicht für jede Schnittstelle einen neuen API-Key zu erstellen. In welcher Gruppe die Daten übertragen werden, wird über die Listen-ID gesteuert. Natürlich können Sie auch für jede Schnittstelle eigene API-Keys verwenden.
- Wenn Sie unsere Schnittstellen verwenden, achten Sie darauf, dass Sie unter Zugriffsrechte "Lese- und Schreibrechte" ausgewählt haben, da sonst keine Daten übertragen werden können. Das Recht "Nur Leserechte" ist also für eigene API-Ansteuerungen gedacht, mit welcher lediglich Daten ausgelesen werden sollen.
- Sie können jederzeit neue API-Keys erstellen und die vorhandenen Löschen bzw. Deaktivieren. Beachten Sie, dass Sie Ihre Schnittstellen anpassen müssen, wenn Sie Änderungen an den API-Keys vornehmen.
- Um eine Listen-ID zu erhalten, muss eine Empfängergruppe existieren.
- Um eine Formular-ID zu erhalten, muss ein entsprechendes Formular für die jeweilige Gruppe angelegt werden.
- Damit die API genutzt werden kann, muss die SOAP-Client-Funktion auf Ihrem Webserver aktiviert sein.