DocumentatieAEM as a Cloud ServiceHandboek

API's op basis van OpenAPI's openapi-based-apis

Last update: Thu Nov 21 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Gemaakt voor:

  • Beheerder
  • Ontwikkelaar
NOTE
OpenAPI's zijn beschikbaar als onderdeel van een programma voor vroege toegang. Als u in de toegang tot van hen geinteresseerd bent, moedigen wij u aan om aem-apis@adobe.commet een beschrijving van uw gebruiksgeval te e-mailen.

Nieuwere AEM as a Cloud Service API's voldoen aan de OpenAPI-specificatie en produceren dus consistente, goed gedocumenteerde en gebruikersvriendelijke API's. Uitgebreide informatie is beschikbaar op de volgende pagina's:

Een veelvoorkomend geval van API-gebruik omvat integratie met systemen zoals een CRM of PIM, waarbij AEM API's worden aangeroepen om gegevens op te halen of te behouden. Als deel van de integratieimplementatie, kunnen de toepassingen aan AEM-emitting gebeurtenissenintekenen, die bedrijfslogica in Adobe App Builder of andere infrastructuur kunnen teweegbrengen.

Ondersteunde API-verificatietypen verschillen op basis van het eindpunt, maar kunnen OAuth Server-to-Server, OAuth Web App en OAuth Single Page App (SPA) zijn.

NOTE
Het leerprogramma van begin tot eindis een geadviseerd middel om te leren hoe te om op OpenAPI-Gebaseerde AEM APIs te vormen en aan te halen.

API-toegang configureren configuring-api-access

Vele op open API-Gebaseerde AEM APIs vereisen authentificatie, die geloofsbrieven vereist worden geproduceerd gebruikend Adobe Developer Console. De configuratie omvat de volgende stappen, die in het leerprogramma worden geïllustreerd:

  1. Verzeker de het productprofielen van uw AEM programma 🔗 worden bijgewerkt en hebben de aangewezen dienst die wordt toegelaten om tot gewenste API toegang te hebben.
  2. Maak een nieuw project in Adobe Developer Console en voeg de gewenste API's toe aan het project en selecteer het juiste verificatietype.
  3. Genereer de referentie, die later wordt gebruikt om een token voor toonder uit te wisselen bij het aanroepen van de API.
  4. Registreer cliëntidentiteitskaart met het milieu door een dossier te vormen YAML, dat gebruikend de Pijpleiding Config (of bevellijn voor RDEs) wordt opgesteld.

Client-id registreren registering-a-client-id

Het bereik van client-id's dat de toegangspunt in een Adobe Developer Console-project heeft voor specifieke AEM. Dit wordt als volgt bereikt:

  1. Maak een bestand met de naam api.yaml of vergelijkbaar met een configuratie zoals het onderstaande fragment, inclusief de gewenste lagen (auteur, publicatie, voorvertoning). Client_id -waarden moeten afkomstig zijn van uw Adobe Developer Console API-project(en).

    De kind, version, en metadata eigenschappen worden beschreven in het artikel van de Pijpleiding Config. De kind bezitswaarde zou aan API moeten worden geplaatst en het version bezit zou aan 1 moeten worden geplaatst.

    code language-none 
    kind: "API"
version: "1"
metadata:
  envTypes: ["dev"]
data:
  allowedClientIDs:
    author:
      - "<client_id>"
    publish:
      - "<client_id>"
    preview:
      - "<client_id>"

  2. Plaats het dossier ergens onder een top niveauomslag genoemd config of gelijkaardig, zoals die onder wordt beschreven Config Pijpleiding.

  3. Voor milieutypes buiten RDE (die het hulpmiddel van de bevellijn gebruikt), creeer een gerichte plaatsing config pijpleiding in Cloud Manager, zoals die door wordt van verwijzingen voorzien deze sectiein het artikel van de Pijpleiding Config. Merk op dat de Volledige pijpleidingen van het Stapel en de pijpleidingen van de Rij van het Web niet het configuratiedossier opstellen.

  4. Implementeer de configuratie.

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab