DocumentatieAEM as a Cloud ServiceHandboek

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

Last update: Thu May 15 2025 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Van toepassing op:
  • Experience Manager as a Cloud Service

Gemaakt voor:

  • Beheerder
  • Ontwikkelaar

Nieuwere AEM as a Cloud Service API's volgen de OpenAPI-specificatie en bieden dus een consistente en goed gedocumenteerde set API's.

NOTE
Een 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.

Voor eindpunten die authentificatie vereisen, verschilt de authentificatiebenadering gebaseerd op het eindpunt, maar kan Server-aan-Server, App van het Web OAuth, of App van één pagina OAuth (SPA) gebruiken. De geloofsbrieven worden gevormd door projecten in Adobe Developer Console.

Veelvoorkomende gevallen van API-gebruik betreffen 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.

Dit document fungeert als een overzicht, maar op de volgende pagina's is meer gedetailleerde documentatie beschikbaar:

  • De verbindingen van de op OpenAPI-Gebaseerde sectie van verwijzingsdocumentatie. De referentiedocumentatie van elke API bevat ook een API-afspeelveld, waarmee u eenvoudig een eindpunt kunt uitproberen met behulp van een token dat met de Adobe Developer Console wordt gegenereerd.

  • Informatieve Gidsen, met inbegrip van API concepten en syntaxis.

  • Een top-level leerprogramma beschrijvend authentificatiemethodesen andere concepten.

  • Een leerprogramma met video concentreerde zich op hoe te om op OpenAPIste vormen.

  • een leerprogramma van begin tot eindover het vormen van en het aanhalen van OpenAPIs met de server-aan-server authentificatiestrategie. Soortgelijke zelfstudies kunt u ook vinden voor webtoepassingen en toepassingen met één pagina.

API-toegang configureren configuring-api-access

Sommige op OpenAPI-Gebaseerde AEM APIs vereisen authentificatie, die geloofsbrieven vereist worden geproduceerd gebruikend Adobe Developer Console. De configuratie omvat de volgende stappen:

  1. Modernisering van de AEM as a Cloud Service-omgeving.
  2. Toegang tot de AEM API's via productprofielen inschakelen. De Profielen van het product worden geassocieerd met de Diensten die de gebruikersgroepen van AEM met vooraf bepaalde Lijsten van het Toegangsbeheer (ACLs) vertegenwoordigen. Terwijl sommige diensten met specifieke productprofielen door gebrek worden geassocieerd, moeten anderen uitdrukkelijk worden geassocieerd; bijvoorbeeld, wordt de Dienst van de Gebruikers van AEM Assets API niet geassocieerd met om het even welk Profiel van het Product, zodat moet u het toelaten om AEM Assets API te gebruiken. Voor meer informatie, zie de toegangsstap van AEM APIstutorial.
  3. Om server-aan-server authentificatie toe te voegen, moet de gebruikersinstellingsintegratie de systeembeheerder van de organisatie in Adobe Admin Console zijn of als Ontwikkelaar aan het Profiel van het Product worden toegevoegd waar de Dienst wordt geassocieerd. Voor meer informatie, zie de toegangsstap van AEM APIstutorial.
  4. Maak een Adobe Developer Console-project (ADC).
  5. Vorm het Project ADC. Dit produceert geloofsbrieven die later zullen worden gebruikt om voor een dragertoken te ruilen wanneer het aanhalen van API.
  6. Vorm de instantie van AEM om de mededeling van het Project van ADC toe te laten. Dit impliceert het registreren van cliëntidentiteitskaart met het milieu door een dossier te vormen en op te stellen YAML, zoals die in wordt beschreven het Registreren van een identiteitskaart van de Cliënthieronder sectie.

Voor gedetailleerde geleidelijke instructies, zie de opstelling op openAPI-Gebaseerde leerprogramma's.

Client-id registreren registering-a-client-id

Client-id's zijn van toepassing op de API's in een Adobe Developer Console-project voor specifieke AEM-omgevingen. 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