Übersicht über AEM-APIs aem-apis-overview
Lernen Sie die verschiedenen API-Typen in Adobe Experience Manager (AEM) as a Cloud Service kennen und erhalten Sie einen Überblick über die auf OpenAPI Specification (OAS) basierenden AEM-APIs, die häufig als OpenAPI-basierte AEM APIs bezeichnet werden.
AEM as a Cloud Service bietet eine Vielzahl von APIs zum Erstellen, Lesen, Aktualisieren und Löschen von Inhalten, Assets und Formularen. Mit diesen APIs können Entwickler benutzerdefinierte Programme erstellen, die mit AEM interagieren.
Im Folgenden werden die verschiedenen API-Typen in AEM erläutert und die Schlüsselkonzepte für den Zugriff auf Adobe-APIs erläutert.
Typen von AEM-APIs types-of-aem-apis
AEM bietet sowohl alte als auch moderne APIs für die Interaktion mit den Typen der Autoren- und Veröffentlichungsdienste.
-
Legacy-APIs: In früheren AEM-Versionen eingeführt, werden ältere APIs weiterhin aus Gründen der Abwärtskompatibilität unterstützt.
-
Moderne APIs: Basierend auf der REST- und OpenAPI-Spezifikation folgen diese APIs den aktuellen Best Practices beim API-Design und werden für neue Integrationen empfohlen.
Weitere Informationen zu AEM-APIs finden Sie in den Adobe Experience Manager as a Cloud Service-APIs.
Im Folgenden werden die OpenAPI-basierten AEM-APIs und die wichtigen Konzepte zum Zugriff auf Adobe-APIs vorgestellt.
OpenAPI-basierte AEM-APIs openapi-based-aem-apis
Die OpenAPI-Spezifikation (früher Swagger genannt) ist ein häufig verwendeter Standard für die Definition von RESTful-APIs. AEM as a Cloud Service bietet verschiedene auf OpenAPI-Spezifikationen basierende APIs (oder einfach OpenAPI-basierte AEM-APIs), die die Erstellung benutzerdefinierter Programme erleichtern, die mit AEM Autoren- oder Veröffentlichungsdiensttypen interagieren. Im Folgenden finden Sie einige Beispiele:
Sites
- Sites-API: APIs zum Arbeiten mit Inhaltsfragmenten.
Assets
-
Ordner-API: APIs zum Arbeiten mit Ordnern wie Erstellen, Auflisten und Löschen von Ordnern.
-
Assets-Autoren-API: APIs zum Arbeiten mit Assets und den zugehörigen Metadaten.
Forms
- Forms Communications-APIs: APIs zum Arbeiten mit Formularen und Dokumenten.
In zukünftigen Versionen werden weitere OpenAPI-basierte AEM-APIs hinzugefügt, um zusätzliche Anwendungsfälle zu unterstützen.
Authentifizierungsunterstützung authentication-support
Die OpenAPI-basierten AEM-APIs unterstützen die folgenden Authentifizierungsmethoden:
-
OAuth Server-zu-Server-Anmeldedaten: Ideal für Backend-Dienste, die API-Zugriff ohne Benutzerinteraktion benötigen. Es wird der Grant-Typ client_credentials verwendet, um eine sichere Zugriffsverwaltung auf Serverebene zu ermöglichen. Weitere Informationen finden Sie unter OAuth Server-zu-Server-Anmeldedaten.
-
OAuth Web App Credential: Geeignet für Webanwendungen mit Frontend- und Backend-Komponenten, die im Namen von Benutzern auf AEM APIs zugreifen. Es wird der Grant-Typ authorization_code verwendet, bei dem der Backend-Server Geheimnisse und Token sicher verwaltet. Weitere Informationen finden Sie unter OAuth Web App Credential.
-
OAuth Single Page App Credential: Wurde für SPA Ausführung im Browser entwickelt, der auf APIs im Namen eines Benutzers ohne Backend-Server zugreifen muss. Es verwendet den Grant-Typ authorization_code und verlässt sich auf clientseitige Sicherheitsmechanismen mithilfe von PKCE (Proof Key for Code Exchange), um den Autorisierungscode-Fluss zu sichern. Weitere Informationen finden Sie unter OAuth Single Page App Credential.
Zugriff auf Adobe-APIs und zugehörige Konzepte accessing-adobe-apis-and-related-concepts
Bevor Sie auf Adobe-APIs zugreifen, müssen Sie sich mit diesen Schlüsselkonzepten vertraut machen:
-
Adobe Developer Console: Der Entwickler-Hub für den Zugriff auf Adobe-APIs, SDKs, Echtzeit-Ereignisse, Server-lose Funktionen und mehr. Beachten Sie, dass es sich von der Developer Console AEM unterscheidet, die zum Debugging von AEM Anwendungen verwendet wird.
-
Adobe Developer Console-Projekt: Zentraler Ort für die Verwaltung von API-Integrationen, Ereignissen und Laufzeitfunktionen. Hier konfigurieren Sie APIs, legen die Authentifizierung fest und generieren erforderliche Anmeldeinformationen.
-
Produktprofile: Produktprofile bieten eine Berechtigungsvorgabe, mit der Sie den Benutzer- oder Anwendungszugriff auf Adobe-Produkte wie AEM, Adobe Target, Adobe Analytics und andere steuern können. Jedem Adobe-Produkt sind vordefinierte Produktprofile zugeordnet.
-
Dienste: Dienste definieren die tatsächlichen Berechtigungen und sind mit dem Produktprofil verknüpft. Um die Berechtigungsvorgabe zu reduzieren oder zu erhöhen, können Sie die mit dem Produktprofil verknüpften Dienste deaktivieren oder auswählen. So können Sie den Umfang des Zugriffs auf das Produkt und seine APIs steuern. In AEM as a Cloud Service stellen Dienste Benutzergruppen mit vordefinierten Zugriffssteuerungslisten (ACLs) für Repository-Knoten dar, was eine granulare Berechtigungsverwaltung ermöglicht.
Nächste Schritte next-steps
Verstehen der verschiedenen AEM API-Typen, einschließlich
OpenAPI-basierte AEM-APIs und die Schlüsselkonzepte für den Zugriff auf Adobe-APIs sind jetzt bereit, mit der Erstellung benutzerdefinierter Programme zu beginnen, die mit AEM interagieren.
Beginnen wir mit dem Tutorial Aufrufen von OpenAPI-basierten AEM-APIs .