Prise en main de REST APIs getting-started-with-rest-apis
Informations sur les exigences générales, authentification, paramètres de requête facultatifs, requête URLs, ainsi que d’autres références.
Configuration requise pour l’API et Recommendations api-requirements-recommendations
Notez ce qui suit lorsque vous utilisez API AUDIENCE MANAGER code :
- Paramètres de requête : tous les paramètres de requête sont requis, sauf indication contraire.
- En-têtes de requête: lors de l’utilisation Adobe Developer jetons, vous devez fournir la variable
x-api-key
en-tête . Vous pouvez obtenir votre API en suivant les instructions de la section Intégration de compte de service page. - JSONtype de contenu : Spécifier
content-type: application/json
etaccept: application/json
dans votre code. - Demandes et réponses : Envoi de requêtes sous la forme correcte JSON . Audience Manager répond avec JSON données formatées. Les réponses du serveur peuvent contenir les données demandées, un code d’état ou les deux.
- Accès : Votre Audience Manager Un consultant vous fournira un identifiant client et une clé qui vous permettent d’effectuer les opérations suivantes : API requêtes.
- Documentation et exemples de code : Texte dans italique représente une variable que vous fournissez ou transmettez lors de la création ou de la réception. API data. Remplacer italicized texte avec votre propre code, paramètres ou d’autres informations requises.
Authentification authentication
La variable Audience Manager REST APIs prennent en charge trois méthodes d’authentification.
- [Recommandé]{class="badge positive"}Authentification OAuth serveur à serveur using Adobe Developer Console. Adobe Developer est l’écosystème de développement et la communauté de l’Adobe. Elle comprend API pour tous les produits Adobe. Il s’agit de la méthode recommandée pour configurer et utiliser Adobe APIs. En savoir plus sur Authentification OAuth serveur à serveur dans la documentation destinée aux développeurs d’Adobes.
- [Obsolète]{class="badge negative"}Authentification JWT (compte de service) using Adobe Developer Console. Adobe Developer est l’écosystème de développement et la communauté de l’Adobe. Elle comprend API pour tous les produits Adobe.
- [Obsolète]{class="badge negative"}Authentification OAuth héritée. Bien que cette méthode soit obsolète, les clients qui disposent d’ OAuth les intégrations peuvent continuer à utiliser cette méthode.
Authentification OAuth serveur à serveur à l’aide d’Adobe Developer oauth-adobe-developer
Cette section explique comment rassembler les informations d’identification requises pour authentifier les appels API d’Audience Manager, comme indiqué dans l’organigramme ci-dessous. Vous pouvez rassembler la plupart des informations d’identification requises dans la configuration initiale unique. Le jeton d’accès doit toutefois être actualisé toutes les 24 heures.
Présentation d’Adobe Developer developer-overview
Adobe Developer est l’écosystème de développement et la communauté de l’Adobe. Elle comprend API pour tous les produits Adobe.
Il s’agit de la méthode recommandée pour configurer et utiliser Adobe APIs.
Conditions préalables prerequisites-server-to-server
Avant de pouvoir configurer OAuth Server-to-Server authentification, assurez-vous que vous avez accès au Console Adobe Developer in Adobe Developer. Contactez l’administrateur de votre entreprise pour les demandes d’accès.
Authentification oauth
Suivez les étapes ci-dessous pour configurer OAuth Server-to-Server authentification Adobe Developer:
- Connectez-vous au Console Adobe Developer.
- Suivez les étapes de la section Guide de mise en oeuvre des informations d’identification OAuth Server-to-Server.
- Durant Étape 2 : Ajout d’une API à votre projet à l’aide de l’authentification du compte de service, choisissez la variable Audience Manager API .
- Essayez la connexion en effectuant votre première API d’après les instructions de Étape 3.
Ajout de l’API d’Audience Manager à un projet add-aam-api-to-project
Accédez à Console Adobe Developer et connectez-vous avec votre Adobe ID. Suivez ensuite les étapes décrites dans le tutoriel sur création d’un projet vide dans la documentation de la console Adobe Developer.
Une fois que vous avez créé un projet, sélectionnez Add API sur le Project Overview écran.
La variable Add an API s’affiche. Sélectionnez l’icône de produit pour Adobe Experience Cloud, puis choisissez Audience Manager API avant de sélectionner Next.
Sélectionnez le type d’authentification OAuth Server-to-Server select-oauth-server-to-server
Sélectionnez ensuite le type d'authentification pour générer les jetons d'accès et accéder à l'API d'Audience Manager.
Sélection des profils de produit pour votre intégration select-product-profiles
Dans le Configure API sélectionnez les profils de produit souhaités. Le compte de service de votre intégration aura accès à des fonctionnalités granulaires par le biais des profils de produits sélectionnés ici.
Sélectionner Save configured API lorsque vous êtes prêt.
Collecte des informations d’identification gather-credentials
Une fois l’API ajoutée au projet, la variable Audience Manager API La page du projet affiche les informations d’identification suivantes, requises dans tous les appels aux API d’Audience Manager :
{API_KEY}
(Client ID){ORG_ID}
(Organization ID)
Générer un jeton d’accès generate-access-token
L’étape suivante consiste à générer une {ACCESS_TOKEN}
informations d’identification à utiliser dans les appels API d’Audience Manager. Contrairement aux valeurs de {API_KEY}
et {ORG_ID}
, un nouveau jeton doit être généré toutes les 24 heures pour continuer à utiliser les API Audience Manager. Sélectionner Generate access token, comme illustré ci-dessous.
Test d’un appel API test-api-call
Après avoir obtenu votre jeton porteur d’authentification, effectuez un appel API pour tester si vous pouvez désormais accéder aux API d’Audience Manager.
-
Accédez au Documentation de référence sur les API.
-
Sélectionner Authorize et collez le jeton d’accès obtenu dans la variable générer un jeton d’accès étape .
-
Effectuez un appel de GET à la fonction
/datasources
point d’entrée d’API pour récupérer une liste de toutes les sources de données disponibles globalement, comme indiqué dans la variable Documentation de référence sur les API. Sélectionner Try it out, suivie de Execute, comme illustré ci-dessous.
code language-shell |
---|
|
Lors de l’utilisation d’un jeton d’accès fonctionnel, le point de terminaison de l’API renvoie une réponse 200, ainsi qu’un corps de réponse qui inclut toutes les sources de données globales auxquelles votre organisation a accès.
code language-json |
---|
|
[Obsolète]{class="badge negative"}JWT (Service Account) Authentification à l’aide d’Adobe Developer jwt
Présentation d’Adobe Developer adobeio
Adobe Developer est l’écosystème de développement et la communauté de l’Adobe. Elle comprend API pour tous les produits Adobe.
Il s’agit de la méthode recommandée pour configurer et utiliser Adobe APIs.
Conditions préalables prerequisites
Avant de pouvoir configurer JWT authentification, assurez-vous que vous avez accès au Console Adobe Developer in Adobe Developer. Contactez l’administrateur de votre entreprise pour les demandes d’accès.
Authentification auth
Suivez les étapes ci-dessous pour configurer JWT (Service Account) authentification Adobe Developer:
- Connectez-vous au Console Adobe Developer.
- Suivez les étapes décrites dans la section Connexion au compte de service.
- Durant Étape 2 : Ajout d’une API à votre projet à l’aide de l’authentification du compte de service, choisissez la variable Audience Manager API .
- Essayez la connexion en effectuant votre première API d’après les instructions de Étape 3.
note note |
---|
NOTE |
Pour configurer et utiliser le Audience Manager REST APIs vous pouvez générer automatiquement la variable JWT par programmation. Voir Authentification JWT (compte de service) pour obtenir des instructions détaillées. |
Autorisations RBAC du compte technique
Si votre compte d’Audience Manager utilise Contrôle d’accès en fonction du rôle, vous devez créer un compte utilisateur technique d’Audience Manager et l’ajouter au groupe RBAC d’Audience Manager qui effectuera les appels d’API.
Pour créer un compte d’utilisateur technique et l’ajouter à un groupe RBAC, procédez comme suit :
-
Effectuez une
GET
appel àhttps://aam.adobe.io/v1/users/self
. L’appel crée un compte d’utilisateur technique que vous pouvez voir dans la variable Admin Console, dans la variable Users page. -
Connectez-vous à votre compte d’Audience Manager et ajouter le compte utilisateur technique ; au groupe d’utilisateurs qui effectuera les appels d’API.
[Obsolète]{class="badge negative"}OAuth Authentification (obsolète) oauth-deprecated
note warning |
---|
WARNING |
Audience Manager REST API authentification et renouvellement des jetons via OAuth 2.0 est désormais obsolète. |
Veuillez utiliser Authentification JWT (compte de service) au lieu de . |
La variable Audience Manager REST API following OAuth 2.0 normes d’authentification et de renouvellement des jetons. Les sections ci-dessous décrivent comment vous authentifier et commencer à utiliser le APIs.
Création d’une variable générique API Utilisateur requirements
Nous vous recommandons de créer un compte d’utilisateur technique distinct pour utiliser la variable Audience Manager APIs. Il s’agit d’un compte générique qui n’est pas associé à un utilisateur spécifique de votre entreprise ou qui ne lui est pas associé. Ce type de API Le compte utilisateur vous permet d’accomplir 2 tâches :
- Identifiez le service qui appelle le API (par exemple, les appels de vos applications qui utilisent notre APIs ou à partir d’autres outils de API requêtes).
- Fournissez un accès ininterrompu au APIs. Un compte lié à une personne spécifique peut être supprimé lorsqu’elle quitte votre société. Cela vous empêchera de travailler avec les API code. Un compte générique qui n’est pas lié à un employé spécifique vous permet d’éviter ce problème.
Par exemple, pour ce type de compte, supposons que vous souhaitiez modifier de nombreux segments à la fois avec la variable Outils de gestion en bloc. Pour ce faire, votre compte d’utilisateur doit API accès. Au lieu d’ajouter des autorisations à un utilisateur spécifique, créez un API compte utilisateur disposant des informations d’identification, de la clé et du secret appropriés pour créer API appels . Cela s’avère également utile si vous développez vos propres applications qui utilisent la variable Audience Manager APIs.
Travaillez avec votre Audience Manager consultant pour configurer une variable générique, APIcompte utilisateur uniquement.
Processus d’authentification par mot de passe password-authentication-workflow
Authentification par mot de passe sécurisé accédez à REST API. Les étapes ci-dessous décrivent le processus d’authentification par mot de passe à partir d’un JSON dans votre navigateur.
note tip |
---|
TIP |
Chiffrez l’accès et actualisez les jetons si vous les stockez dans une base de données. |
Étape 1 : Requête API Accès
Contactez votre responsable Partenaires en solutions . Ils vous fourniront un API ID client et secret. L’identifiant et le secret vous authentifient dans la variable API.
Remarque : si vous souhaitez recevoir un jeton d’actualisation, indiquez-le lorsque vous demandez API accès.
Étape 2 : demander le jeton
Transmettre une requête de jeton avec vos préférences JSON client. Lorsque vous créez la requête :
- Utilisez une
POST
méthode d’appelhttps://api.demdex.com/oauth/token
. - Convertissez votre ID client et votre secret client en chaîne codée en base 64. Séparez l’ID et le secret par deux points au cours du processus de conversion. Par exemple, les informations d’identification
testId : testSecret
convertir endGVzdElkOnRlc3RTZWNyZXQ=
. - Transmettre HTTP headers
Authorization:Basic <base-64 clientID:clientSecret>
etContent-Type: application/x-www-form-urlencoded
. Par exemple, votre en-tête peut ressembler à ceci :Authorization: Basic dGVzdElkOnRlc3RTZWNyZXQ=
Content-Type: application/x-www-form-urlencoded
- Configurez le corps de la requête comme suit :
grant_type=password&username=<your-AudienceManager-user-name>&password=<your-AudienceManager-password>
Étape 3 : Réception du jeton
La variable JSON La réponse contient votre jeton d’accès. La réponse doit se présenter comme suit :
code language-json |
---|
|
La variable expires_in
key représente le nombre de secondes jusqu’à l’expiration du jeton d’accès. Pour respecter les bonnes pratiques, utilisez de courts délais d’expiration pour limiter l’exposition si le jeton est un jour exposé.
Actualiser le jeton refresh-token
Actualiser le renouvellement des jetons API accéder après l’expiration du jeton d’origine. Si nécessaire, la réponse JSON dans le workflow du mot de passe, inclut un jeton d’actualisation. Si vous ne recevez pas de jeton d’actualisation, créez-en un nouveau par le biais du processus d’authentification par mot de passe.
Vous pouvez également utiliser un jeton d’actualisation pour générer un nouveau jeton avant l’expiration du jeton d’accès existant.
Si votre jeton d’accès a expiré, vous recevez un 401 Status Code
et l’en-tête suivant dans la réponse :
WWW-Authenticate: Bearer realm="oauth", error="invalid_token", error_description="Access token expired: <token>"
Les étapes suivantes décrivent le processus d’utilisation d’un jeton d’actualisation pour créer un jeton d’accès à partir d’un JSON dans votre navigateur.
Étape 1 : demander le nouveau jeton
Transmettez une requête de jeton d’actualisation avec vos préférences. JSON client. Lorsque vous créez la requête :
- Utilisez une
POST
méthode d’appelhttps://api.demdex.com/oauth/token
. - Convertissez votre ID client et votre secret client en chaîne codée en base 64. Séparez l’ID et le secret par deux points au cours du processus de conversion. Par exemple, les informations d’identification
testId : testSecret
convertir endGVzdElkOnRlc3RTZWNyZXQ=
. - Transmission des en-têtes HTTP
Authorization:Basic <base-64 clientID:clientSecret>
etContent-Type: application/x-www-form-urlencoded
. Par exemple, votre en-tête peut ressembler à ceci :Authorization: Basic dGVzdElkOnRlc3RTZWNyZXQ=
Content-Type: application/x-www-form-urlencoded
- Dans le corps de la requête, spécifiez la variable
grant_type:refresh_token
et transmettez le jeton d’actualisation que vous avez reçu dans votre demande d’accès précédente. La requête doit se présenter comme suit :grant_type=refresh_token&refresh_token=b27122c0-b0c7-4b39-a71b-1547a3b3b88e
Étape 2 : réception du nouveau jeton
La variable JSON La réponse contient votre nouveau jeton d’accès. La réponse doit se présenter comme suit :
code language-json |
---|
|
Code d’autorisation et authentification implicite authentication-code-implicit
La variable Audience Manager REST API prend en charge le code d’autorisation et l’authentification implicite. Pour utiliser ces méthodes d’accès, les utilisateurs doivent se connecter à https://api.demdex.com/oauth/authorize
pour accéder aux jetons et les actualiser.
Faire authentifier API Demandes authenticated-api-requests
Conditions requises pour l’appel API une fois que vous avez reçu un jeton d’authentification.
Pour lancer des appels par rapport à la disponibilité API methods:
- Dans le
HTTP
header, setAuthorization: Bearer <token>
. - Lorsque vous utilisez Authentification JWT (compte de service), vous devez fournir la variable
x-api-key
, qui sera identique à votreclient_id
. Vous pouvez obtenir votreclient_id
de la Intégration d’Adobe Developer page. - Appelez les API .
Facultatif API Paramètres de requête optional-api-query-parameters
Définissez les paramètres facultatifs disponibles pour les méthodes qui renvoient toutes les propriétés d’un objet.
Vous pouvez utiliser ces paramètres facultatifs avec API méthodes renvoyées all propriétés d’un objet. Définissez ces options dans la chaîne de requête lors de la transmission de cette requête à la variable API.
page
pageSize
sortBy
descending
ascending
est la valeur par défaut.search
GET https://aam.adobe.io/v1/models/?search=Test
. Vous pouvez rechercher n’importe quelle valeur renvoyée par un "get all".folderId
permissions
Renvoie une liste de segments basée sur l’autorisation spécifiée. READ
est la valeur par défaut. Les autorisations incluent :
READ
: renvoie et affiche des informations sur un segment.WRITE
: utilisezPUT
pour mettre à jour un segment.CREATE
: utilisezPOST
pour créer un segment.DELETE
: permet de supprimer un segment. Nécessite l’accès aux caractéristiques sous-jacentes, le cas échéant. Par exemple, vous aurez besoin de droits pour supprimer les caractéristiques qui appartiennent à un segment si vous souhaitez le supprimer.
Spécifiez plusieurs autorisations avec des paires clé-valeur distinctes. Par exemple, pour renvoyer une liste de segments avec READ
et WRITE
autorisations uniquement, transmettre "permissions":"READ"
, "permissions":"WRITE"
.
includePermissions
true
pour renvoyer vos autorisations pour le segment. Par défaut : false
.Remarque À Propos Des Options De Page
Lorsque des informations sur la page n’est pas spécifié, la requête renvoie plain JSON donne un tableau. Si des informations sur la page is spécifié, alors la liste renvoyée est encapsulée dans une JSON contenant des informations sur le résultat total et la page active. Votre exemple de requête utilisant les options de page peut ressembler à ceci :
GET https://aam.adobe.io/v1/models/?page=1&pageSize=2&search=Test
API URLs api-urls
URLs pour les demandes, les environnements d’évaluation et de production, ainsi que les versions.
Requête URLs request-urls
Le tableau suivant répertorie la requête. URLs utilisé pour transmettre API requêtes, par méthode.
Selon la méthode d’authentification que vous utilisez, vous devez ajuster votre requête. URLs selon les tableaux ci-dessous.
Requête URLs pour le [Recommandé]{class="badge positive"}[Obsolète]{class="badge negative"}JWT Authentification 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 /
Segments :
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/
Requête URLs pour le [Obsolète]{class="badge negative"}OAuth Authentification 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 /
Segments :
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/
Environnements environments
La variable Audience Manager APIs permettent d’accéder à différents environnements de travail. Ces environnements vous aident à tester le code par rapport à des bases de données distinctes sans affecter les données de production en direct. Le tableau suivant répertorie les API environnements et noms d’hôtes de ressources correspondants.
Selon la méthode d’authentification que vous utilisez, vous devez ajuster votre environnement. URLs selon le tableau ci-dessous.
https://aam.adobe.io/...
https://api.demdex.com/...
https://aam-beta.adobe.io/...
https://api-beta.demdex.com/...
Versions versions
Nouvelles versions de ces APIs sont publiés selon un calendrier régulier. Une nouvelle version incrémente le API numéro de version. Le numéro de version est référencé dans la requête. URL as v<version number>
comme illustré dans l’exemple suivant :
https://<host>/v1/...
Codes de réponse définis response-codes-defined
HTTP
codes d’état et texte de réponse renvoyés par la variable Audience Manager REST API.
200
OK
201
Created
PUT
et POST
requêtes.204
No Content
400
Bad Request
403
Forbidden
404
Not Found
409
Conflict
500
Server Error