Anforderungen

Grundlagen

  • Grundlagen von AEM Mobile
  • Grundlagen des Erstellens und Veröffentlichens von Inhalten über das On-Demand-Portal
  • Erfahrung mit On-Demand Services APIs

Erforderliche Produkte

  • AEM Mobile
  • Zugriff auf die On-Demand Services API

Einführung

Adobe Experience Manager Mobile (AEM Mobile) verfügt über die leistungsfähige On-Demand Services API, mit der Sie programmgesteuert u. a. Artikel, Sammlungen, Produkte und Push-Benachrichtigungen verwalten können. Die API ermöglicht auch die Integration mit Produkten von Drittanbietern, z. B. Content Management-Systemen, webbasierten Authoring-Werkzeugen und Systemen für den Veröffentlichungsarbeitsablauf, von denen viele inzwischen verfügbar sind. (Weitere Informationen finden Sie unter Integration von Drittanbietersystemen mit AEM Mobile.)

Unabhängig davon, ob Sie benutzerdefinierten Code mit einer Schnittstelle zur On-Demand Services API schreiben oder eine der vorhandenen Integrationen mit Systemen von Drittanbietern nutzen möchten, benötigen Sie gültige API-Anmeldeinformationen. In diesem Artikel wird die Verwendung von API-Schlüsseln erläutert.

 

API-Anmeldeinformationen

API-Anmeldeinformationen bestehen aus den folgenden Elementen:

  • API-Schlüssel und geheimer Clientschlüssel sind die Anmeldedaten für den Zugriff auf das API Gateway.
  • Geräte-ID und Gerätetoken sind die Anmeldedaten für die Identifizierung des API-Benutzers.

Einsatzszenarien und Anforderungen für die API

Abhängig von der geplanten Schnittstelle zu den On-Demand Services APIs gelten die folgenden Anforderungen.

Gehostete Lösung (mehrere Mandanten)

Beispiele: WoodWing Enterprise, WoodWing Inception, Storied und Specle.

  • Für jede gehostete Lösung ist ein eigener API-Schlüssel erforderlich.
  • Benutzer der gehosteten Lösung benötigen keinen eigenen API-Schlüssel.
  • Der Eigentümer der Lösung stellt seinen API-Schlüssel für die Benutzer/Kunden bereit.
  • Benutzer der gehosteten Lösung generieren ihre eigene Geräte-ID und ihr eigenes Gerätetoken mit diesem API-Schlüssel und geben die Anmeldeinformationen in der gehosteten Lösung ein.

Lokale Lösung (ein Mandant)

Beispiele: Adobe Experience Manager, vjoon K4, WordPress und Drupal.

  • Jeder Kunde, der eine lokale Lösung bereitstellen möchte, benötigt einen eigenen API-Schlüssel.
  • Ein Kunde kann den API-Schlüssel in mehreren von ihm implementierten lokalen Lösungen verwenden.
  • Der Kunde muss seine eigene Geräte-ID und sein eigenes Gerätetoken erstellen und diese Anmeldeinformationen in seiner lokalen Lösung eingeben.

Benutzerdefinierte Integration

Beispiel: Von einem Partner oder Kunden codierter benutzerdefinierter Arbeitsablauf

  • Es gelten die gleichen Anforderungen wie für den lokalen Fall (ein Mandant).
  • Der Kunde benötigt einen eigenen API-Schlüssel, Geräte-ID(s) und Token.

In den folgenden Abschnitten erhalten Sie Informationen zum Abrufen der benötigten API-Anmeldeinformationen.

Anfordern eines API-Schlüssels

Ein API-Schlüssel wird für den Zugriff auf das Adobe API Gateway benötigt. Dieses Gateway ist eine allgemeine Infrastruktur, die auch von den APIs verwendet wird. Alle öffentlichen APIs befinden sich hinter dem Adobe API Gateway. Damit Sie mit Diensten hinter dem API Gateway interagieren können, benötigen Sie einen API-Schlüssel. API-Schlüssel sind nicht an eine bestimmte Adobe ID gebunden und laufen nicht ab, es sei denn, sie werden von Adobe widerrufen. Der API-Schlüssel besteht aus zwei Teilen: dem Namen und dem geheimen Schlüssel. Sie können sich den geheimen Schlüssel als Kennwort für den API-Schlüssel vorstellen.

Der API-Schlüssel und der geheime Clientschlüssel werden oft anders bezeichnet. Die folgenden Begriffe beschreiben das Gleiche:

API-Schlüssel = IMS-Client-ID = Client-ID = Adobe API-Schlüssel = Adobe-Schlüssel

Geheimer Clientschlüssel = geheimer Schlüssel = geheimer Adobe API-Schlüssel = geheimer Adobe-Schlüssel

Wenn Sie einen API-Schlüssel anfordern möchten, laden Sie das PDF-Anforderungsformular herunter und reichen Sie es ein. Weitere Informationen finden Sie unter Integration von Drittanbietersystemen mit AEM Mobile: API-Schlüssel.

Es wird empfohlen, keine Adobe IDs von Hauptadministratoren für den API-Zugriff zu verwenden. Verwenden Sie Hauptadministratorkonten nur zum Erstellen von Projekten und zum Hinzufügen von dedizierten Konten zu den erforderlichen Projekten. Wenn Sie beispielsweise über eine Drupal-Instanz und eine Wordpress-Instanz verfügen und der Hauptadministrator „aemm_master@adobe.com“ ist, könnte die zugewiesene API-Adobe ID für Drupal „aemm_drupal@adobe.com“ lauten (kein Hauptadministrator). Die Adobe ID für WordPress könnte „aemm_wordpress@adobe.com“ lauten (kein Hauptadministrator). Sie können dann z. B. die Projekte „Drupal Mag“ und „Wordpress Mag“ mit „aemm_master@adobe.com“ erstellen und „aemm_drupal@adobe.com“ und „aemm_wordpress@adobe.com“ nur mit den notwendigen Rollen und Berechtigungen diesen Projekten hinzufügen. (Gewähren Sie diesen dedizierten API-Konten nur die Berechtigungen, die für die jeweilige API benötigt werden, z. B. „Inhalt hinzufügen und bearbeiten“, „Inhalt löschen“, „Inhalt anzeigen“ und „Inhalt veröffentlichen“. In der Dokumentation für Ihre Lösung finden Sie die jeweils erforderlichen Berechtigungen. Siehe Kontoverwaltung für AEM Mobile.

Wenn Ihre Anforderung gewährt wird, erhalten Sie eine IMS-Client-ID (Ihren API-Schlüssel) und den geheimen Clientschlüssel. Die angegebenen Adobe IDs werden auf die Positivliste gesetzt, damit Sie entsprechende Geräte-IDs und Gerätetoken erstellen können, wie in den nächsten Schritten beschrieben.

 

 

 

Generieren der Geräte-ID und des Gerätetokens

Wenn Ihnen der API-Schlüssel und der geheime Clientschlüssel vorliegen, müssen Sie eine Geräte-ID und ein Gerätetoken generieren, mit denen der API-Benutzer identifiziert wird.

  1. Rufen Sie die Seite für den IMS-Geräte-Token-Generator („AEX-Portal“) unter https://aex.aemmobile.adobe.com/ auf und geben Sie Ihren API-Schlüssel/die IMS-Client-ID ein.
  2. Melden Sie sich mit der Adobe ID von der Positivliste an, für die Sie eine Geräte-ID/ein Token erstellen möchten (eine der Adobe IDs, die Sie im Anforderungsformular für den API-Schlüssel angegeben haben).
  3. Es werden eine Geräte-ID und ein Gerätetoken generiert und angezeigt. Kopieren Sie diese und speichern Sie sie an einem sicheren Ort.

Beachten Sie, dass die Geräte-ID bzw. das Gerätetoken ungültig wird, wenn das Kennwort für Ihre Adobe ID geändert wird. Sie können die Geräte-ID/das Gerätetoken als Hash aus Adobe ID und Kennwort betrachten.

Beachten Sie außerdem, dass die Geräte-ID/das Gerätetoken 6 Monate lang gültig sind und ungültig werden, wenn sie nicht verwendet werden. Wenn sie verwendet werden, werden sie automatisch verlängert.

Zugriff auf die AEM Mobile API

Wenn Sie über APIs eine Verbindung mit einem unterstützten Drittanbietersystem herstellen, müssen Sie nur den API-Schlüssel und den geheimen Clientschlüssel (nur für lokale Lösungen/ein Mandant), die Geräte-ID und das Gerätetoken beim Einrichten des Systems in den entsprechenden Feldern eingeben.

Wenn Sie auf die API direkt über Ihren eigenen benutzerdefinierten Code zugreifen, befolgen Sie die Dokumentation im Paket für die On-Demand Services API:

  • Mit der Geräte-ID bzw. dem Gerätetoken wird ein Zugriffstoken über den Authentication API-Endpunkt generiert.
  • Die Kombination aus API-Schlüssel und Zugriffstoken wird für alle API-Aufrufe benötigt.

Verwenden von API-Schlüsseln in Entwicklungs- und Produktionsumgebungen

Wenn Sie eine benutzerdefinierte Integration entwickeln oder lokal über verschiedene Systeme für Produktion und Entwicklung verfügen, sollten Sie verschiedene API-Schlüssel für Entwicklung und Produktion verwenden.

Wenn Sie ein neues System entwickeln, können Sie mit dem oben beschrieben Verfahren einen API-Schlüssel anfordern. Nachdem Sie ein System in Produktion bereitgestellt haben, müssen Sie einen zusätzlichen API-Schlüssel anfordern.

Einstellung von technischen Geräte-ID- und Gerätetokenkonten

Zukünftig wird der Arbeitsablauf für Geräte-ID und Gerätetoken durch die Implementierung eines neuen technischen Kontos ersetzt, das über das On-Demand-Portal verwaltet wird. Die API-Schlüssel bleiben unverändert. Anstatt eine Geräte-ID und ein Gerätetoken für die Authentifizierung (und das Abrufen eines Zugriffstokens) zu verwenden, stellt das System ein „technisches Konto“ bereit, über das das Zugriffstoken angefordert werden kann. Für das Bootstrapping des Verfahrens wird ein „Einmal-Token“ generiert. Dieser Bezeichner kann nur einmal verwendet werden. Der Nutzer der Kontoinformationen tauscht das Einmal-Token über einen Adobe-Dienst gegen ein Authentifizierungstoken ein. Das resultierende Token kann für zukünftige Authentifizierungen gespeichert werden.

Dieses Werk unterliegt den Bedingungen der Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License.  Twitter™- und Facebook-Beiträge fallen nicht unter die Bedingungen der Creative Commons-Lizenz.

Rechtliche Hinweise   |   Online-Datenschutzrichtlinie