API-Explorer
Eine Anwendungsprogrammierschnittstelle (API) ist eine Möglichkeit für zwei oder mehr Computerprogramme, miteinander zu kommunizieren. Es handelt sich um eine Art von Software-Schnittstelle, die einen Dienst für Softwares anbietet. Innerhalb von Selligent by Zeta werden mehrere APIs verwendet.
Die API-Dokumentation ist über das Modul „API Explorer“ im Bereich „Module“ in der oberen Symbolleiste verfügbar.
Sie können API-Aufrufe direkt von diesem Modul aus durchführen. Eine umfassende Bibliothek aller verfügbaren Methoden finden Sie in der DevPortal-Dokumentation hier. Beachten Sie jedoch, dass von hier aus keine API-Aufrufe durchgeführt werden können. Wir empfehlen, das DevPortal als Ihre Bibel und das Modul „API Explorer“ als Testumgebung zu verwenden.
Hinweis: Die Startberechtigung muss so eingestellt sein, um auf das Selligent Modul zugreifen zu können. Dadurch erhalten Sie Zugriff sowohl auf das Selligent Modul als auch auf das API-Explorer-Modul.
Sie können Vorgänge von Selligent API-Endpunkten mit ihren Selligent HTTP-Methoden (GET, POST, PUT, DELETE) anzeigen und ausführen. Jeder Vorgang zeigt ein Modell und einen Beispielwert sowie Parameter zum Ausfüllen von Werten; Antwortdetails werden bei der Ausführung angezeigt.
Beginnen Sie mit der Eingabe des Authentifizierungsschlüssels und der geheimen Frage oben rechts.
Hinweis : Sie müssen einen Authentifizierungsschlüssel und einen geheimen Schlüssel eingeben, um die API zu verwenden. Bitten Sie Ihren Systemadministrator, einen zu erzeugen.
Im API Explorer können Sie Informationen dazu finden, wie Sie eine Methode verwenden und welche Parameter weitergegeben werden sollen. Die Methode kann ausserdem getestet werden.
Jeder Abschnitt kann erweitert werden, sodass Sie alle verfügbaren Methoden sehen.
Beispiel einer Antwort
Das DevPortal bietet ähnliche Dokumentations- und Testmöglichkeiten, zusammen mit Beispielen, Antworten, Beschreibungen von Feldern und mehr. Ein Änderungsprotokoll sowie eine Anleitung, wie man die Schlüssel erhält, sind verfügbar.
Der API-Explorer kann auch über die folgende URL aufgerufen werden: http(s)://yourdomain/Portal/Api/swagger
Das DevPortal ist über die folgende URL zugänglich: https://developers.meetmarigold.com/engage/api/
Für transaktionale Journeys können Sie den API-Explorer mit seiner Dokumentation (in einer neuen Registerkarte) vom Assistenten zur Erstellung von Journeys durch Klicken auf den Link „hier“ aus starten.
Technischer Hinweis : Eine spezifische Methode ist verfügbar, um den Zustand einer Transaktionsnachricht abzurufen. Weitere Informationen zu den möglichen zurückgegebenen Zuständen finden Sie in diesem speziellen Thema.
Wichtige Anmerkung: Benutzerdefinierte X-Forwarded-Host-Header in API-Aufrufen werden nicht unterstützt.
Renderer API-Explorer
Der Renderer API-Explorer ist direkt vom Abschnitt „Module“ in der oberen Symbolleiste aus verfügbar.
Hinweis: Die Startberechtigung muss so eingestellt sein, dass auf Campaign und den Renderers API Explorer zugegriffen werden kann.
Auf ihn kann auch über die folgende URL zugegriffen werden:
http(s)://yourdomain/renderers/swagger
Der Renderer API-Explorer wird für Content Rendering verwendet.
Hinweis : Sowohl der API-Explorer als auch der Renderer API-Explorer haben ihre eigene dedizierte interne Dokumentation.
