DocumentatieExperience PlatformDeveloper Console en Postman instellen

Developer Console en Postman instellen

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Onderwerpen:
  • API

Gemaakt voor:

  • Beginner
  • tussenpersoon
  • Ontwikkelaar

In deze les stelt u een project in in de Adobe Developer Console en downloadt u Postman -verzamelingen, zodat u de API's van het platform kunt gebruiken.

Om de API oefeningen in dit leerprogramma te voltooien, download app van Postman voor uw werkend systeem. Hoewel het niet nodig is om Experience Platform-API's te gebruiken, maakt Postman API-workflows eenvoudiger en biedt Adobe Experience Platform tientallen Postman-verzamelingen om u te helpen API-aanroepen uit te voeren en te leren hoe ze werken. De rest van deze zelfstudie gaat uit van enige praktische kennis van Postman. Voor hulp, gelieve te verwijzen de documentatie van Postman.

Platform is in eerste instantie een API. Terwijl de interfaceopties ook voor alle belangrijke taken bestaan, zou u de Platform API op één of ander punt kunnen willen gebruiken. Bijvoorbeeld om gegevens in te voeren, om punten tussen zandbakken te bewegen, routinetaken te automatiseren of nieuwe eigenschappen van het Platform te gebruiken alvorens de gebruikersinterface is gebouwd.

Architecten van Gegevens en Ingenieurs van Gegevens kunnen Platform API buiten dit leerprogramma moeten gebruiken.

Vereiste machtigingen

In vorm toestemmingenles, u opstelling alle toegangscontroles die worden vereist om deze les te voltooien.

Adobe Developer Console instellen

Adobe Developer Console is de ontwikkelaarsbestemming om tot Adobe APIs & SDKs toegang te hebben, aan bijna gebeurtenissen in real time te luisteren, functies in Runtime in werking te stellen, of plugins of de toepassingen van App Builder te bouwen. U gebruikt deze voor toegang tot de Experience Platform-API. Voor meer details, zie de documentatie van Adobe Developer Console

  1. Maak op uw lokale computer een map met de naam Luma Tutorial Assets voor bestanden die in de zelfstudie worden gebruikt.

  2. Open Adobe Developer Console

  3. Meld u aan en bevestig dat u zich in de juiste organisatie bevindt

  4. Selecteer Create New Project in het menu Quick Start .

    creeer Nieuw Project

  5. Selecteer in het nieuwe project de knop Edit Project

  6. Wijzig Project Title in Luma Tutorial API Project (voeg uw naam aan het eind toe, als meerdere personen van uw bedrijf deze zelfstudie volgen)

  7. Selecteren Save

    Adobe Developer Console Project API Config

  8. Selecteren Add API

    Adobe Developer Console Project API Config

  9. De lijst filteren door Adobe Experience Platform te selecteren

  10. Selecteer Experience Platform API in de lijst met beschikbare API's en selecteer Next .

    Adobe Developer Console Project API Config

  11. Selecteer OAuth Server-to-Server als referentie en selecteer Next .
    Uitgezochte Server-aan-Server

  12. Selecteer het productprofiel van AEP-Default-All-Users en selecteer Save Configured API

    Uitgezochte Profiel van het Product

  13. Nu is uw Developer Console-project gemaakt!

  14. Selecteer Download for Postman in de sectie Try it out van de pagina en selecteer OAuth Server-to-Server om het Postman omgeving-json-bestand te downloaden. Sla oauth_server_to_server.postman_environment.json op in de map Luma Tutorial Assets .

    Adobe Developer Console Project API Config

Systeembeheerder de API-referentie aan de rol toevoegen

Als u de API-referentie wilt gebruiken voor interactie met het Experience Platform, moet u een System Admin (Systeembeheer) de API-referenties toewijzen aan de rol die in de vorige les is gemaakt. Als u geen Systeembeheerder bent, verzendt u deze:

  1. The Name of your API Credential (Credential in Luma Tutorial API Project)

  2. De Technical Account Email van uw referentie (dit helpt de systeembeheerder de referentie te vinden)

    Name en Technical Account Email van uw referentie

Hier volgen de instructies voor de systeembeheerder:

  1. Logboek in Adobe Experience Platform

  2. Selecteer Permissions in de linkernavigatie die u naar het Roles -scherm brengt.

  3. De rol Luma Tutorial Platform openen
    open de rol

  4. Selecteer de tab API Credentials

  5. Selecteren Add API Credentials
    voeg credentie toe

  6. Zoek de referentie van Credential in Luma Tutorial API Project en filtreer met de Technical Account Email die door de tutorial participant is opgegeven als de lijst lang is

  7. Selecteer de referentie

  8. Selecteren Save

    voeg credentie toe

Postman instellen

CAUTION
De Postman-interface wordt regelmatig bijgewerkt. De schermafbeeldingen in deze zelfstudie zijn gemaakt met Postman 10.15.1 voor Mac, maar de interfaceopties zijn mogelijk gewijzigd.

  1. Downloaden en installeren Postman

  2. Postman openen en een werkruimte maken
    het milieu van de Invoer

  3. Importeer het gedownloade JSON-omgevingsbestand, oauth_server_to_server.postman_environment.json
    het milieu van de Invoer

  4. Selecteer in Postman de omgeving in de vervolgkeuzelijst

  5. Selecteer het pictogram om de omgevingsvariabelen weer te geven:

    milieu van de Verandering

Sandbox-naam en Tenant-id toevoegen

De variabelen SANDBOX_NAME en TENANT_ID en CONTAINER_ID worden niet opgenomen in de Adobe Developer Console-export en worden dus handmatig toegevoegd:

  1. In Postman, open de Variabelen van het Milieu

  2. Selecteer uitgeven verbinding aan het recht van de milieunaam

  3. In voeg nieuw veranderlijk gebied toe, ga SANDBOX_NAME in

  4. Voer in beide waardevelden luma-tutorial de naam in die we in de vorige les aan onze sandbox hebben gegeven. Als u een andere naam hebt gebruikt voor uw sandbox, bijvoorbeeld luma-tutorial-ignatiusjreilly, moet u die waarde gebruiken.

  5. In voeg nieuw veranderlijk gebied toe, ga TENANT_ID in

  6. De schakelaar aan uw Webbrowser en kijkt omhoog huurder identiteitskaart van uw bedrijf door naar de interface van het Experience Platform te gaan en het gedeelte van URL na @ teken te halen. Mijn huurder-id is bijvoorbeeld techmarketingdemos , maar die van u is anders:

    het verkrijgen van huurder identiteitskaart van de interface URL van het Platform

  7. Deze waarde kopiëren en terugkeren naar het scherm Postman Omgevingen beheren

  8. Plak de id van de huurder in beide waardevelden

  9. In voeg nieuw veranderlijk gebied toe, ga CONTAINER_ID in

  10. Voer global in beide waardevelden in

    note note
    NOTE
    CONTAINER_ID is een veld waarvan de waarde tijdens de zelfstudie meerdere keren wordt gewijzigd. Wanneer global wordt gebruikt, communiceert de API met Adobe-geleverde elementen in uw account Platform. Wanneer tenant wordt gebruikt, communiceert de API met uw eigen aangepaste elementen.

  11. Selecteer sparen

    SANDBOX_NAME, TENANT_ID, en de gebieden CONTAINER_ID die als milieuvariabelen worden toegevoegd

API-aanroepen maken

Een toegangstoken ophalen

Adobe biedt een uitgebreide set Postman -verzamelingen waarmee u de API van het Experience Platform kunt verkennen. Deze inzamelingen zijn in de Postman Steekproeven GitHub repo van Adobe Experience Platform. U zou referentie deze repo aangezien u dit vele tijden door dit leerprogramma en later zult gebruiken aangezien u Experience Platform voor uw eigen bedrijf uitvoert.

De eerste verzameling werkt met de Adobe Identity Management Service (IMS)-API's. Het is een handige manier om een toegangstoken op te halen vanuit Postman.

Om het toegangstoken te produceren:

  1. Download de inzameling van de Dienst APIs van Identity Managementaan uw Luma Tutorial Assets omslag

  2. De verzameling importeren in Postman

  3. Selecteer het verzoek Auth: De Token van de Toegang van het verzoek verzoek en selecteert verzenden

  4. Er moet een reactie van het type 200 OK met een toegangstoken in het antwoord worden opgenomen

    verzoek de tokens

  5. Het toegangstoken zou automatisch als ACCESS_TOKEN milieuvariabele van uw Postman milieu moeten worden opgeslagen.

    Postman

Interactie met een platform-API

Nu maken een Platform API vraag om te bevestigen dat wij alles correct hebben gevormd.

Open de Experience Platform Postman inzamelingen in GitHub. Deze pagina bevat veel verzamelingen voor verschillende platform-API's. Ik beveel ten stelligste aan dat er een bladwijzer wordt gemaakt.

Nu, maken onze eerste API vraag:

  1. Download de inzameling van de Registratie API van het Schemaaan uw Luma Tutorial Assets omslag
  2. Importeren in Postman
  3. Open de Registratie API van het Schema > Schema's > de schema's van de Lijst
  4. Bekijk de Punten van Params en Kopballen lusjes en neem nota hoe zij enkele milieuvariabelen omvatten die wij vroeger inging.
  5. Merk op dat de Kopballen > waardegebied goedkeurt aan application/vnd.adobe.xed-id+json wordt geplaatst. De Registratie APIs van het Schema vereist één van deze gespecificeerde Accept kopbalwaardendie verschillende formaten in de reactie verstrekken.
  6. Selecteer verzenden om uw eerste vraag van Platform API te maken!

Hopelijk hebt u een succesvolle 200 OK reactie gekregen die een lijst van de beschikbare Adobe-Geleide schema's XDM in uw zandbak, zoals hieronder wordt afgebeeld.

Eerste API vraag in Postman

Als uw vraag niet succesvol was, neem een ogenblik om het gebruiken van de details van de foutenreactie van de API vraag te zuiveren en de stappen hierboven te herzien. Als u geplakt wordt, gelieve om hulp in het Communautaire Forumof gebruik de verbinding in de rechterkant van deze pagina aan "Logboek een kwestie".

Met uw toestemmingen van het Platform, zandbak, en Postman opstelling, bent u klaar aan modelgegevens in schema's!

recommendation-more-help
513160b6-bf42-4c58-abdd-4f817b1cccad