Managed Runtime API

Verwenden Sie die Managed Runtime API, um die in Managed Runtime von Commerce Cloud bereitgestellten Anwendungen zu kontrollieren. Sie können benutzerdefinierte Tools erstellen, die über die gleichen Funktionalitäten wie die Runtime Admin-Webanwendung verfügen, erhalten darüber hinaus aber noch mehr Administrationsfähigkeiten und Konfigurationsoptionen.

Die Managed Runtime API ist ausschließlich für Administrationszwecke gedacht. Stellen Sie in Ihrem Storefront-Code keine Anfragen an diese API.

In dieser Anleitung wird davon ausgegangen, dass Sie bereits mit Managed Runtime und verwandten Konzepten wie Projekten, Umgebungen, Bündeln und Bereitstellungen vertraut sind. Näheres dazu finden Sie in der Übersicht über Managed Runtime.

Der Markenname Mobify wird noch in der Domain mobify.com in der Basis-URL für die Managed Runtime API verwendet. Obwohl die neuen Salesforce-Domains letztendlich die Mobify-Domain ersetzen werden, wird die Mobify-Domain weiterhin unterstützt.

Um Anfragen an die API zu senden, müssen Sie im Header Authorization der HTTP-Anfrage einen API-Schlüssel mit dem Wert Bearer {{api_key}} einfügen.

Um Ihren API-Schlüssel zu finden, melden Sie sich beim Tool Runtime Admin an und rufen Sie die Seite Account Settings (Kontoeinstellungen) auf.

Behandeln Sie Ihren API-Schlüssel wie ein Passwort, denn damit können Skripte Vorgänge in Ihrem Namen ausführen.

Wir zeigen Ihnen gleich in einem kurzen Tutorial anhand einiger als curl-Befehle formatierten Beispielanfragen, wie Sie die API verwenden.

Ersetzen Sie vor der Ausführung der Befehle alle Platzhalter mit den tatsächlichen Werten. Platzhalter haben das folgende Format: {{placeholder}}.

Bei den meisten Anfragen müssen Sie {{project_id}} mit Ihrer tatsächlichen Projekt-ID ersetzen. Um Ihre Projekt-ID zu finden, melden Sie sich beim Tool Runtime Admin an und rufen Sie die Seite mit den Einstellungen Ihres Projekts auf.

Project-IDs können aus bis zu 20 Zeichen bestehen und müssen für die Organisation eindeutig sein.

Unsere erste Anfrage an die Managed Runtime API führt alle Umgebungen (oder "Ziele", wie sie in der API genannt werden) auf, die zu einem Projekt gehören:

Jetzt erstellen wir eine Umgebung namens staging, mit der wir Änderungen vor ihrer Bereitstellung in production verifizieren können:

Bevor Sie Ihre neue Umgebung nutzen können, müssen Sie ein Bündel darin bereitstellen.

Sehen wir uns die Details der von uns erstellten staging-Umgebung an:

Als Letztes modifizieren wir die Proxy-Konfiguration für staging:

Durch die Änderung der Konfiguration wird das aktuelle Bündel automatisch erneut bereitgestellt, damit die Änderungen in Kraft treten.

Wenn Sie bei der Verwendung der API auf Probleme stoßen, versuchen Sie die folgenden Schritte zur Fehlerbehebung:

  • Fügen Sie Ihrem curl-Befehl das Argument --fail hinzu.
  • Überprüfen Sie Ihren API-Schlüssel.
  • Überprüfen Sie die ID Ihres Projekts.

Die API-Endpunkte funktionieren auch in einem Browser. Melden Sie sich im Runtime Admin-Tool an und öffnen Sie den verwendeten Endpunkt direkt in Ihrem Browser.

Jetzt wissen Sie, was die API alles kann. Sie können nun selbst einige Beispielanfragen stellen! In der API-Spezifikation erfahren Sie mehr zur API.