Aan de slag met REST APIs getting-started-with-rest-apis
Informatie over algemene vereisten, authentificatie, facultatieve vraagparameters, verzoek URLsen andere verwijzingen.
API-vereisten en Recommendations api-requirements-recommendations
Let op het volgende wanneer u werkt met Audience Manager-API code:
- Parameters aanvragen: alle aanvraagparameters zijn vereist, tenzij anders aangegeven.
- Aanvraagkoppen: bij gebruik Adobe Developer tokens, u moet de
x-api-key
header. U kunt uw API door de instructies in de Integratie van serviceaccount pagina. - JSONinhoudstype: Opgeven
content-type: application/json
enaccept: application/json
in uw code. - Verzoeken en antwoorden: Aanvragen verzenden als een correct opgemaakt bestand JSON object. Audience Manager reageert met JSON opgemaakte gegevens. Serverreacties kunnen gevraagde gegevens, een statuscode of beide bevatten.
- Toegang: Uw Audience Manager consultant zal u een klant-id en een sleutel geven waarmee u API verzoeken.
- Documentatie en codevoorbeelden: Tekst in cursief vertegenwoordigt een variabele die u verstrekt of binnen overgaat wanneer het maken of het ontvangen API gegevens. Vervangen cursief tekst met uw eigen code, parameters of andere vereiste informatie.
Verificatie authentication
De Audience Manager REST APIs drie verificatiemethoden ondersteunen.
- [Aanbevolen]{class="badge positive"}OAuth Server-to-Server Authentificatie gebruiken Adobe Developer Console. Adobe Developer is het ecosysteem en de gemeenschap van ontwikkelaars van Adobe. Hieronder vallen API's voor alle Adobe producten. Dit is de aanbevolen manier om Adobe APIs. Meer informatie over OAuth Server-to-Server Authentificatie in de Adobe Developer documentation.
- [Vervangen]{class="badge negative"}JWT-verificatie (serviceaccount) gebruiken Adobe Developer Console. Adobe Developer is het ecosysteem en de gemeenschap van ontwikkelaars van Adobe. Hieronder vallen API's voor alle Adobe producten.
- [Vervangen]{class="badge negative"}Oudere OAuth-verificatie. Hoewel deze methode is vervangen, kunnen klanten met bestaande OAuth Deze methode kan worden gebruikt voor integraties.
OAuth Server-to-Server Authentificatie gebruikend Adobe Developer oauth-adobe-developer
Deze sectie behandelt hoe te om de vereiste geloofsbrieven te verzamelen om Audience Manager API vraag voor authentiek te verklaren, zoals die in het stroomschema hieronder wordt geschetst. U kunt de meeste vereiste geloofsbrieven in eerste éénmalige opstelling verzamelen. Het toegangstoken, echter, moet om de 24 uur worden verfrist.
Adobe Developer - Overzicht developer-overview
Adobe Developer is het ecosysteem en de gemeenschap van ontwikkelaars van Adobe. Hieronder vallen API's voor alle Adobe producten.
Dit is de aanbevolen manier om Adobe APIs.
Vereisten prerequisites-server-to-server
Voordat u kunt configureren OAuth Server-to-Server verificatie, zorg ervoor dat u toegang hebt tot de Adobe Developer Console in Adobe Developer. Neem contact op met uw organisatiebeheerder voor verzoeken om toegang.
Verificatie oauth
Voer de onderstaande stappen uit om te configureren OAuth Server-to-Server verificatie met Adobe Developer:
- Aanmelden bij de Adobe Developer Console.
- Voer de stappen in het dialoogvenster OAuth Server-to-Server referentie implementatiegids.
- Tijdens Stap 2: voeg API aan uw project toe gebruikend de authentificatie van de Rekening van de Dienst, kiest u de Audience Manager API -optie.
- Probeer de verbinding uit door eerst uw API vraag gebaseerd op de instructies van Stap 3.
Audience Manager-API toevoegen aan een project add-aam-api-to-project
Ga naar Adobe Developer Console en meld u aan met uw Adobe ID. Voer vervolgens de stappen uit die in de zelfstudie worden beschreven een leeg project maken in de Adobe Developer Console-documentatie.
Als u een nieuw project hebt gemaakt, selecteert u Add API op de Project Overview scherm.
De Add an API wordt weergegeven. Selecteer het productpictogram voor Adobe Experience Cloud en kies Audience Manager API voordat u selecteert Next.
Selecteer het verificatietype OAuth Server-to-Server select-oauth-server-to-server
Selecteer vervolgens het verificatietype dat u wilt maken voor het genereren van toegangstokens en voor toegang tot de Audience Manager-API.
Selecteer de productprofielen voor uw integratie select-product-profiles
In de Configure API selecteert u de gewenste productprofielen. Via de hier geselecteerde productprofielen krijgt het serviceaccount van uw integratie toegang tot korrelfuncties.
Selecteren Save configured API wanneer u klaar bent.
Referenties verzamelen gather-credentials
Zodra API aan het project is toegevoegd, Audience Manager API De pagina voor het project toont de volgende geloofsbrieven die in alle vraag aan Audience Manager APIs worden vereist:
{API_KEY}
(Client ID){ORG_ID}
(Organization ID)
Een toegangstoken genereren generate-access-token
De volgende stap bestaat uit het genereren van een {ACCESS_TOKEN}
referentie voor gebruik in Audience Manager API vraag. In tegenstelling tot de waarden voor {API_KEY}
en {ORG_ID}
moet om de 24 uur een nieuw token worden gegenereerd om Audience Manager API's te kunnen blijven gebruiken. Selecteren Generate access token, zoals hieronder weergegeven.
Een API-aanroep testen test-api-call
Nadat u het token van de verificatiehouder hebt opgehaald, voert u een API-aanroep uit om te testen of u nu toegang hebt tot Audience Manager-API's.
-
Ga naar de API-naslagdocumentatie.
-
Selecteren Authorize en plak het toegangstoken dat u in het toegangstoken genereren stap.
-
Voer een vraag van de GET aan uit
/datasources
API eindpunt om een lijst van alle globaal beschikbare gegevensbronnen terug te winnen, zoals die in wordt vermeld API-naslagdocumentatie. Selecteren Try it out, gevolgd door Execute, zoals hieronder weergegeven.
code language-shell |
---|
|
Wanneer het gebruiken van een werkend toegangstoken, keert het API eindpunt een 200 reactie, samen met een antwoordlichaam terug dat alle globale gegevensbronnen omvat die uw organisatie toegang heeft tot.
code language-json |
---|
|
[Vervangen]{class="badge negative"}JWT (Service Account) Verificatie met Adobe Developer jwt
Adobe Developer - Overzicht adobeio
Adobe Developer is het ecosysteem en de gemeenschap van ontwikkelaars van Adobe. Hieronder vallen API's voor alle Adobe producten.
Dit is de aanbevolen manier om Adobe APIs.
Vereisten prerequisites
Voordat u kunt configureren JWT verificatie, zorg ervoor dat u toegang hebt tot de Adobe Developer Console in Adobe Developer. Neem contact op met uw organisatiebeheerder voor verzoeken om toegang.
Verificatie auth
Voer de onderstaande stappen uit om te configureren JWT (Service Account) verificatie met Adobe Developer:
- Aanmelden bij de Adobe Developer Console.
- Voer de stappen uit in Verbinding serviceaccount.
- Tijdens Stap 2: voeg API aan uw project toe gebruikend de authentificatie van de Rekening van de Dienst, kiest u de Audience Manager API -optie.
- Probeer de verbinding uit door eerst uw API vraag gebaseerd op de instructies van Stap 3.
note note |
---|
NOTE |
Om te vormen en met het Audience Manager REST APIs op een geautomatiseerde manier kunt u de JWT programmatisch. Zie JWT-verificatie (serviceaccount) voor gedetailleerde instructies. |
Machtigingen voor RBAC's van technische rekeningen
Als uw Audience Manager-account Op rollen gebaseerd Toegangsbeheer, moet u een technische gebruikersrekening van de Audience Manager tot stand brengen en het toevoegen aan de Audience Manager RBAC groep die de API vraag zal maken.
Voer de onderstaande stappen uit om een technische gebruikersaccount te maken en deze toe te voegen aan een RBAC-groep:
-
Maak een
GET
oproep aanhttps://aam.adobe.io/v1/users/self
. De vraag zal tot een technische gebruikersrekening leiden die u in kunt zien Admin Consolein de Users pagina. -
Meld u aan bij uw Audience Manager-account en toevoegen aan de technische gebruikersaccount aan de gebruikersgroep die de API vraag zal maken.
[Vervangen]{class="badge negative"}OAuth Verificatie (afgekeurd) oauth-deprecated
note warning |
---|
WARNING |
Audience Manager REST API tokenauthentificatie en vernieuwing via OAuth 2.0 is nu afgekeurd. |
Gebruik JWT-verificatie (serviceaccount) in plaats daarvan. |
De Audience Manager REST API volgt OAuth 2.0 normen voor tokenauthentificatie en vernieuwing. In de onderstaande secties wordt beschreven hoe u de verificatie uitvoert en met de functie APIs.
Een generiek bestand maken API Gebruiker requirements
We raden u aan een aparte, technische gebruikersaccount te maken voor het werken met de Audience Manager APIs. Dit is een generieke account die niet is gekoppeld aan of gekoppeld aan een specifieke gebruiker in uw organisatie. Dit type van API Met gebruikersaccount kunt u twee dingen doen:
- Identificeer welke dienst roept API (Bijvoorbeeld, vraag van uw apps die onze gebruiken APIs of van andere gereedschappen die API verzoeken).
- Ononderbroken toegang tot de APIs. Een account die aan een bepaalde persoon is gekoppeld, kan worden verwijderd wanneer deze uw bedrijf verlaat. Zo voorkomt u dat u met de beschikbare API code. Met een algemene account die niet aan een bepaalde werknemer is gekoppeld, voorkomt u dit probleem.
Als voorbeeld of gebruiksgeval voor dit type van rekening, laten wij zeggen u veel segmenten in één keer met wilt veranderen Bulkbeheertools. Wel, om dit te doen, heeft uw gebruikersrekening nodig API toegang. In plaats van machtigingen toe te voegen aan een specifieke gebruiker, maakt u een niet-specifieke gebruiker. API gebruikersaccount met de juiste gegevens, sleutel en geheim om API oproepen. Dit is ook handig als u uw eigen toepassingen ontwikkelt die gebruikmaken van de Audience Manager APIs.
Werk met uw Audience Manager consultant voor het opzetten van een generiek API-only user account.
Workflow voor wachtwoordverificatie password-authentication-workflow
Wachtwoordverificatie veilige toegang tot onze REST API. De onderstaande stappen geven een overzicht van de workflow voor wachtwoordverificatie via een JSON in uw browser.
note tip |
---|
TIP |
Codeer toegang en vernieuw tokens als u hen in een gegevensbestand opslaat. |
Stap 1: Verzoek API Toegang
Contacteer uw manager van de Oplossingen van de Partner. Zij zullen u van een API client-id en geheim. De id en het geheim verifiëren u aan API.
Opmerking: als u een vernieuwingstoken wilt ontvangen, geeft u dat op wanneer u een aanvraag indient API toegang.
Stap 2: De token aanvragen
Geef een symbolische aanvraag door aan uw voorkeur JSON client. Wanneer u het verzoek bouwt:
- Een
POST
methode om aan te roepenhttps://api.demdex.com/oauth/token
. - Zet uw cliënt ID en geheim in een basis-64 gecodeerde koord om. Scheid de id en het geheim tijdens het conversieproces met een dubbele punt. Bijvoorbeeld de referenties
testId : testSecret
omzetten indGVzdElkOnRlc3RTZWNyZXQ=
. - Geef in HTTP headers
Authorization:Basic <base-64 clientID:clientSecret>
enContent-Type: application/x-www-form-urlencoded
. De koptekst kan er bijvoorbeeld als volgt uitzien:Authorization: Basic dGVzdElkOnRlc3RTZWNyZXQ=
Content-Type: application/x-www-form-urlencoded
- Stel de aanvraaginstantie als volgt in:
grant_type=password&username=<your-AudienceManager-user-name>&password=<your-AudienceManager-password>
Stap 3: Ontvang het token
De JSON reactie bevat uw toegangstoken. De reactie moet er als volgt uitzien:
code language-json |
---|
|
De expires_in
key vertegenwoordigt het aantal seconden tot het toegangstoken verloopt. U kunt het beste korte vervaltijden gebruiken om de belichting te beperken als het token ooit wordt blootgesteld.
Token vernieuwen refresh-token
Tokens vernieuwen API toegang nadat het originele teken verloopt. Indien gevraagd, het antwoord JSON in de wachtwoordworkflow bevat een token voor vernieuwen. Als u ontvangt vernieuw symbolisch, creeer nieuwe door het proces van de wachtwoordauthentificatie.
U kunt ook een vernieuwingstoken gebruiken om een nieuw token te genereren voordat het bestaande toegangstoken verloopt.
Als uw toegangstoken is verlopen, ontvangt u een 401 Status Code
en de volgende koptekst in het antwoord:
WWW-Authenticate: Bearer realm="oauth", error="invalid_token", error_description="Access token expired: <token>"
In de volgende stappen wordt een overzicht gegeven van de workflow voor het gebruik van een vernieuwingstoken om een nieuw toegangstoken te maken van een JSON in uw browser.
Stap 1: Nieuwe token aanvragen
Geef een vernieuwingstoken-aanvraag door aan uw voorkeur JSON client. Wanneer u het verzoek bouwt:
- Een
POST
methode om aan te roepenhttps://api.demdex.com/oauth/token
. - Zet uw cliënt ID en geheim in een basis-64 gecodeerde koord om. Scheid de id en het geheim tijdens het conversieproces met een dubbele punt. Bijvoorbeeld de referenties
testId : testSecret
omzetten indGVzdElkOnRlc3RTZWNyZXQ=
. - Geef in de HTTP-headers door
Authorization:Basic <base-64 clientID:clientSecret>
enContent-Type: application/x-www-form-urlencoded
. De koptekst kan er bijvoorbeeld als volgt uitzien:Authorization: Basic dGVzdElkOnRlc3RTZWNyZXQ=
Content-Type: application/x-www-form-urlencoded
- Vermeld in de aanvraaginstantie de
grant_type:refresh_token
en ga binnen vernieuwen teken u in uw vorig toegangsverzoek ontving. Het verzoek moet er als volgt uitzien:grant_type=refresh_token&refresh_token=b27122c0-b0c7-4b39-a71b-1547a3b3b88e
Stap 2: Ontvang het Nieuwe Token
De JSON de reactie bevat uw nieuw toegangstoken. De reactie moet er als volgt uitzien:
code language-json |
---|
|
Autorisatiecode en impliciete verificatie authentication-code-implicit
De Audience Manager REST API steunt vergunningscode en impliciete authentificatie. Om deze toegangsmethodes te gebruiken, moeten uw gebruikers login aan https://api.demdex.com/oauth/authorize
om tokens te openen en te vernieuwen.
Verifiëren API Verzoeken authenticated-api-requests
Vereisten voor oproepen API methoden nadat u een verificatietoken hebt ontvangen.
Om vraag tegen beschikbaar te maken API methoden:
- In de
HTTP
header, setAuthorization: Bearer <token>
. - Wanneer u JWT-verificatie (serviceaccount), moet u de
x-api-key
koptekst, die hetzelfde zal zijn als uwclient_id
. U kunt uwclient_id
van de Adobe Developer-integratie pagina. - De vereiste vraag API methode.
Optioneel API Zoekparameters optional-api-query-parameters
Stel de optionele parameters in die beschikbaar zijn voor methoden die alle eigenschappen voor een object retourneren.
U kunt deze optionele parameters gebruiken met API methoden die worden geretourneerd alles eigenschappen voor een object. Stel deze opties in de tekenreeks request wanneer u die query doorgeeft aan de API.
page
pageSize
sortBy
descending
ascending
is standaard.search
GET https://aam.adobe.io/v1/models/?search=Test
. U kunt zoeken op elke waarde die wordt geretourneerd door "get all".folderId
permissions
Retourneert een lijst met segmenten op basis van de opgegeven machtiging. READ
is standaard. Bevoegdheden omvatten:
READ
: De terugkeer en meningsinformatie over een segment.WRITE
: GebruikPUT
een segment bijwerken.CREATE
: GebruikPOST
om een segment te maken.DELETE
: Een segment verwijderen. Vereist toegang tot eventuele onderliggende kenmerken. Bijvoorbeeld, zult u rechten nodig hebben om de eigenschappen te schrappen die tot een segment behoren als u het wilt verwijderen.
Geef meerdere machtigingen op met afzonderlijke sleutelwaardeparen. Als u bijvoorbeeld een lijst met segmenten wilt retourneren met READ
en WRITE
alleen machtigingen, doorgeven "permissions":"READ"
, "permissions":"WRITE"
.
includePermissions
true
om uw toestemmingen voor het segment terug te keren. Standaard is false
.Een opmerking over paginaopties
Wanneer paginagegevens is niet gespecificeerd, keert het verzoek onbewerkt terug JSON resulteert in een array. Als paginagegevens is opgegeven, wordt de geretourneerde lijst opgenomen in een JSON object dat informatie bevat over het totale resultaat en de huidige pagina. Uw voorbeeldverzoek met behulp van paginaopties kan er als volgt uitzien:
GET https://aam.adobe.io/v1/models/?page=1&pageSize=2&search=Test
API URLs api-urls
URLs voor verzoeken, het opvoeren en productiemilieu's, en versies.
Verzoek URLs request-urls
De volgende tabel bevat de aanvraag URLs gebruikt om binnen te gaan API verzoeken, via methode.
Afhankelijk van de authentificatiemethode die u gebruikt, moet u uw verzoek aanpassen URLs volgens onderstaande tabellen.
Verzoek URLs voor de [Aanbevolen]{class="badge positive"}[Vervangen]{class="badge negative"}JWT Verificatie via Adobe Developer request-urls-jwt
https://aam.adobe.io/v1/models/
https://aam.adobe.io/v1/datasources/
https://aam.adobe.io/v1/signals/derived/
https://aam.adobe.io/v1/destinations/
https://aam.adobe.io/v1/partner-sites/
https://aam.adobe.io/v1/folders/traits /
Segmenten:
https://aam.adobe.io/v1/folders/segments /
https://aam.adobe.io/v1/schemas/
https://aam.adobe.io/v1/segments/
https://aam.adobe.io/v1/traits/
https://aam.adobe.io/v1/customer-trait-types
https://aam.adobe.io/v1/taxonomies/0/
Verzoek URLs voor de [Vervangen]{class="badge negative"}OAuth Verificatie request-urls-oauth
https://api.demdex.com/v1/models/
https://api.demdex.com/v1/datasources/
https://api.demdex.com/v1/signals/derived/
https://api.demdex.com/v1/destinations/
https://api.demdex.com/v1/partner-sites/
https://api.demdex.com/v1/folders/traits /
Segmenten:
https://api.demdex.com/v1/folders/segments /
https://api.demdex.com/v1/schemas/
https://api.demdex.com/v1/segments/
https://api.demdex.com/v1/traits/
https://api.demdex.com/v1/customer-trait-types
https://api.demdex.com/v1/taxonomies/0/
Omgevingen environments
De Audience Manager APIs biedt toegang tot verschillende werkomgevingen. Deze milieu's helpen u code tegen afzonderlijke gegevensbestanden testen zonder levende, productiegegevens te beïnvloeden. In de volgende tabel worden de beschikbare API omgevingen en bijbehorende hostnamen van bronnen.
Afhankelijk van de verificatiemethode die u gebruikt, moet u uw omgeving aanpassen URLs volgens onderstaande tabel.
https://aam.adobe.io/...
https://api.demdex.com/...
https://aam-beta.adobe.io/...
https://api-beta.demdex.com/...
Versies versions
Nieuwe versies van deze APIs worden vrijgegeven volgens een regelmatig schema. Een nieuwe release verhoogt de API versienummer. Naar het versienummer wordt verwezen in de aanvraag URL als v<version number>
zoals in het volgende voorbeeld wordt getoond:
https://<host>/v1/...
Responscodes gedefinieerd response-codes-defined
HTTP
statuscodes en reactietekst die door de Audience Manager REST API.
200
OK
201
Created
PUT
en POST
verzoeken.204
No Content
400
Bad Request
403
Forbidden
404
Not Found
409
Conflict
500
Server Error