Vereisten

Vereiste kennis

  • Kennis van AEM Mobile
  • Kennis van het maken en publiceren van inhoud via de on-demandportal
  • Ervaring met On-Demand Services API's

Vereiste producten

  • AEM Mobile
  • Toegang tot de On-Demand Services API

Inleiding

Adobe Experience Manager Mobile (AEM Mobile) biedt een krachtige On-Demand Services API waarmee u programmamatig artikelen, collecties, producten, pushmeldingen en meer kunt beheren De API maakt ook externe integratie met inhoudsbeheersystemen, webgebaseerde ontwerpgereedschappen en publicatieworkflowsystemen mogelijk, waarvan er op dit moment veel beschikbaar zijn. (Zie Systemen van derden integreren met AEM Mobile voor meer informatie.)

Of u nu aangepaste code wilt schrijven waarmee een interface met de On-Demand Services API wordt gemaakt of voordeel wilt halen uit een van de bestaande integraties met externe systemen, u hebt altijd geldige API-referenties nodig. In dit artikel wordt uitgelegd hoe API-sleutels worden gebruikt.

 

API-referenties

API-referenties bestaan uit de volgende items:

  • API-sleutel en Clientgeheim zijn referenties voor toegang tot de API-gateway.
  • Device-id en Apparaattoken zijn referenties om de API-gebruiker te identificeren.

Scenario's en vereisten van API-gebruik

Afhankelijk van hoe u van plan bent om een interface op te zetten via de On-Demand Services API zijn de volgende vereisten van toepassing.

Gehoste oplossing (meerdere gebruikers)

Voorbeelden: WoodWing Enterprise, WoodWing Inception, Storied, en Specle.

  • Elke gehoste oplossing vereist een eigen API-sleutel.
  • Gebruikers van de gehoste oplossingen hebben geen eigen API-sleutel nodig.
  • De eigenaar van de oplossing levert de eigen API-sleutel aan gebruikers/klanten.
  • Gebruikers van de gehoste oplossing genereren hun eigen apparaat-id en apparaattoken met gebruik van de API-sleutel. Deze referenties geven zij vervolgens op in de gehoste oplossing.

Oplossing op locatie (enkele gebruiker)

Voorbeelden: Adobe Experience Manager, vjoon K4, WordPress en Drupal.

  • Elke klant die een oplossing op locatie wil implementeren, heeft een eigen API-sleutel nodig.
  • Een klant kan de eigen API-sleutel gebruiken op meerdere oplossingen op locatie die deze implementeert.
  • Een klant moet een eigen apparaat-id en apparaattoken genereren en deze referenties vervolgens opgeven in hun oplossing op locatie.

Aangepaste integratie

Voorbeeld: aangepaste workflow gecodeerd door een partner of klant.

  • Dezelfde vereisten als in het geval van een oplossing op locatie (enkele gebruiker).
  • De klant heeft een eigen API-sleutel, eigen apparaat-id's en apparaattokens nodig.

Zie de volgende secties voor informatie over het verkrijgen van de API-referenties die u nodig hebt.

Een API-sleutel aanvragen

Een API-sleutel wordt gebruikt voor toegang tot de Adobe API-gateway. Deze gateway is een algemene infrastructuur die ook wordt gebruikt door de API's. Alle openbare API's bevinden zich achter de Adobe API-gateway. Voor interactie met de services achter de API-gateway hebt u een API-sleutel nodig. API-sleutels worden niet verbonden aan een individuele Adobe ID en verlopen niet tenzij Adobe deze intrekt. De API-sleutel bestaat uit twee delen: de naam en het geheim. U kunt het geheim zien als het “wachtwoord” voor de API-sleutel.

De API-sleutel en het clientgeheim worden soms met andere namen aangeduid. De volgende termen zijn equivalenten van elkaar:

API-sleutel = “IMS Client-id” = “Client-id” = “Adobe API-sleutel” = “Adobe-sleutel”

Clientgeheim = “Geheim” = “Adobe API-geheim” = “Adobe-geheim”

Als u een API-sleutel wilt aanvragen, downloadt en verzendt u het aanvraagformulier (PDF). Zie Systemen van derden integreren met AEM Mobile: API-sleutels voor meer informatie.

Het wordt aanbevolen GEEN Adobe ID's van hoofdbeheerders te gebruiken voor API-toegang. Gebruik alleen hoofdbeheerdersaccounts om projecten te maken en voeg toegewezen accounts toe aan elk van de nodige projecten. Als u bijvoorbeeld beschikt over een exemplaar van Drupal en een exemplaar van WordPress en uw hoofdbeheerder is aemm_master@adobe.com, kan uw toegewezen API Adobe ID voor Drupal aemm_drupal@adobe.com (geen hoofdbeheerder) zijn. Uw toegewezen Adobe ID voor WordPress kan aemm_wordpress@adobe.com (geen hoofdbeheerder) zijn. U kunt vervolgens bijvoorbeeld projecten maken met de naam “Drupal Mag” en “WordPress Mag” via aemm_master@adobe.com, en aemm_drupal@adobe.com en aemm_wordpress@adobe.com toevoegen aan deze projecten met alleen de benodigde rollen en rechten. (Geef alleen de rechten aan deze toegewezen API-accounts die nodig zijn voor het verwachte API-gebruik, zoals “Inhoud toevoegen en bewerken”, “Inhoud weergeven” en “Inhoud publiceren”. Raadpleeg de documentatie voor uw oplossing voor de specifieke rechten die nodig zijn. Zie Accountbeheer voor AEM Mobile.

Als uw verzoek wordt ingewilligd, ontvangt u een IMS Client-id (dit is uw API-sleutel) en uw clientgeheim. Uw opgegeven Adobe ID's komen op de witte lijst te staan, zodat u gekoppelde apparaat-id's en apparaattokens kunt maken, zoals wordt beschreven in de volgende stappen.

 

 

 

De apparaat-id en apparaattoken genereren

Zodra u een API-sleutel en clientgeheim hebt, kunt u een apparaat-id en apparaattoken genereren, die worden gebruikt om de API-gebruiker te identificeren.

  1. Ga naar de IMS Device Token Generator (“AEX Portal”) op https://aex.aemmobile.adobe.com/ en geef uw API-sleutel/IMS Client-id op.
  2. Meld u aan met de Adobe ID uit de witte lijst, waarvoor u een apparaat-id/-token wilt maken (een van de Adobe ID's die u hebt opgegeven in het aanvraagformulier voor de API-sleutel).
  3. Er wordt een apparaat-id en apparaattoken gegenereerd en weergegeven. Kopieer deze gegevens en sla deze op een veilige locatie op.

Houd er rekening mee dat de apparaat-id/apparaattoken ongeldig wordt als het wachtwoord van de Adobe ID wordt gewijzigd. U kunt de apparaat-id/apparaattoken zien als een afgeleide van de Adobe ID en het wachtwoord van de Adobe ID.

Houd er ook rekening mee dat de apparaat-id/apparaattoken 6 maanden geldig is en ongeldig wordt als deze niet wordt gebruikt. Als deze wel wordt gebruikt, wordt deze automatisch vernieuwd.

Toegang tot de AEM Mobile API

Als u een ondersteund extern systeem verbindt via de API's, hoeft u alleen de API-sleutel en het clientgeheim (alleen voor oplossingen op locatie/voor enkele gebruiker), de apparaat-id en de apparaattoken op te geven in de daarvoor bedoelde velden in het configuratieproces van het systeem.

Als u direct via uw aangepaste code toegang krijgt tot de API, volgt u de documentatie in het pakket On-Demand Services API:

  • De apparaat-id/apparaattoken wordt gebruikt om een toegangstoken te genereren via het eindpunt van de Authentication API.
  • De combinatie van de API-sleutel en de toegangstoken is vereist voor alle aanroepen van API's.

API-sleutels gebruiken in ontwikkelings- en productieomgevingen

Als u een aangepaste integratie ontwikkelt of als u een afzonderlijk systeem voor productie en ontwikkeling op locatie hebt, moet u afzonderlijke API-sleutels voor ontwikkeling en productie gebruiken.

Wanneer u een nieuw systeem ontwikkelt, kunt u een API-sleutel aanvragen via de procedure die hierboven wordt beschreven. Zodra u begint met de implementatie van een systeem in productie, moet u een aanvullende API-sleutel aanvragen.

Technische accounts vervangen de apparaat-id en apparaattoken

In de toekomst wordt de workflow voor apparaat-id's en apparaattokens vervangen door een implementatie van een nieuw technisch account dat wordt beheerd via de on-demandportal. De API-sleutels blijven van toepassing. In plaats van een apparaat-id en apparaattoken voor verificatie (en om een toegangstoken te verkrijgen) biedt het systeem een “technisch account” dat kan worden gebruikt om een toegangstoken aan te vragen. Een “eenmalige token” wordt gegenereerd om het proces te starten. Deze id kan slechts één keer worden gebruikt. De consument van de accountinformatie wisselt de eenmalige token in voor een verificatietoken via een Adobe-service. De resulterende token kan worden opgeslagen voor toekomstige verificatie.

Dit werk is gelicentieerd onder de Creative Commons Naamsvermelding/Niet-commercieel/Gelijk delen 3.0 Unported-licentie  De voorwaarden van Creative Commons zijn niet van toepassing op Twitter™- en Facebook-berichten.

Juridische kennisgevingen   |   Online privacybeleid