Prise en main de REST APIs getting-started-with-rest-apis

Présentation d’Adobe Developer adobeio

Adobe Developer est l’écosystème et la communauté de développeurs d’Adobe. Elle comprend des 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 l’authentification JWT, vérifiez que vous avez accès au Adobe Developer Console dans Adobe Developer. Contactez l’administrateur ou l’administratrice de votre organisation pour les demandes d’accès.

Authentification auth

Pour configurer l’authentification JWT (Service Account) à l’aide de Adobe Developer, procédez comme suit :

1. Connectez-vous à Adobe Developer Console.
2. Suivez les étapes de la section Connexion au compte de service.
   • Au cours de Étape 2 : ajouter une API à votre projet à l’aide de l’authentification du compte de service, choisissez l’option Audience Manager API .
3. Testez la connexion en effectuant votre premier appel API en fonction des instructions de l’étape 3.

Autorisations RBAC de compte technique

Si votre compte Audience Manager utilise le contrôle d’accès en fonction du rôle, vous devez créer un compte d’utilisateur technique Audience Manager et l’ajouter au groupe RBAC Audience Manager qui effectuera les appels API.

Pour créer un compte d’utilisateur technique et l’ajouter à un groupe RBAC, procédez comme suit :

1. Appelez-GET https://aam.adobe.io/v1/users/self. L’appel crée un compte d’utilisateur technique que vous pouvez voir dans le Admin Console, dans la page Users .

   

2. Connectez-vous à votre compte Audience Manager et ajoutez le compte d’utilisateur technique au groupe d’utilisateurs qui effectuera les appels API.

La Audience Manager REST API suit les normes OAuth 2.0 pour l’authentification et le renouvellement des jetons. Les sections ci-dessous décrivent comment vous authentifier et commencer à utiliser les API.

Créer un utilisateur API générique requirements

Nous vous recommandons de créer un compte utilisateur technique distinct pour travailler avec les Audience Manager API. Il s’agit d’un compte générique qui n’est pas lié à un utilisateur spécifique de votre organisation ni associé à celui-ci. Ce type de compte utilisateur API permet d’accomplir deux choses :

• Identifiez le service qui appelle le API (par exemple, les appels de vos applications qui utilisent nos API ou d’autres outils qui font des demandes API).
• Assurer un accès ininterrompu aux API. Un compte lié à une personne spécifique peut être supprimé lorsqu’elle quitte votre entreprise. Cela vous empêchera d’utiliser le code API disponible. Un compte générique qui n'est pas lié à un employé particulier vous aide à éviter ce problème.

À titre d’exemple ou de cas d’utilisation pour ce type de compte, supposons que vous souhaitiez modifier de nombreux segments à la fois avec les outils de gestion en bloc. Pour ce faire, votre compte utilisateur doit disposer d’un accès API. Au lieu d’ajouter des autorisations à un utilisateur spécifique, créez un compte utilisateur API non spécifique disposant des informations d’identification, de la clé et du secret appropriés pour effectuer des appels API. Cela s’avère également utile si vous développez vos propres applications qui utilisent les Audience Manager API.

Contactez votre consultant Audience Manager pour configurer un compte utilisateur générique en API seule.

Workflow d’authentification de mot de passe password-authentication-workflow

L'authentification par mot de passe sécurise l'accès à nos REST API. Les étapes ci-dessous décrivent le processus d’authentification par mot de passe à partir d’un client JSON dans votre navigateur.

Étape 1 : Demander l'accès API

Contactez votre responsable des solutions partenaires. Ils vous fourniront un identifiant client et un secret API. L’identifiant et le secret vous authentifient auprès de l’API.

Remarque : si vous souhaitez recevoir un jeton d’actualisation, indiquez-le lorsque vous demandez un accès API.

Étape 2 : demander le jeton

Transmettez une demande de jeton avec votre client JSON préféré. Lorsque vous créez la requête :

• Utilisez une méthode POST pour appeler https://api.demdex.com/oauth/token.
• Convertissez votre identifiant client et votre secret en une chaîne codée en base-64. Séparez l’ID et le secret par deux points pendant le processus de conversion. Par exemple, les informations d’identification testId : testSecret converties en dGVzdElkOnRlc3RTZWNyZXQ=.
• Transmettez le HTTP headers Authorization:Basic <base-64 clientID:clientSecret> et Content-Type: application/x-www-form-urlencoded . Par exemple, votre en-tête pourrait 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 : recevoir le jeton

La réponse JSON contient votre jeton d’accès. La réponse doit se présenter comme suit :

{
    "access_token": "28fed402-eafd-456c-9341-ac753f25bbbc",
    "token_type": "bearer",
    "refresh_token": "b27122c0-b0c7-4b39-a71b-1547a3b3b88e",
    "expires_in": 21922,
    "scope": "read write"
}

La clé expires_in représente le nombre de secondes avant l’expiration du jeton d’accès. De bonnes pratiques recommandent d’utiliser des délais d’expiration courts pour limiter l’exposition si le jeton est jamais exposé.

Jeton d’actualisation refresh-token

Les jetons d’actualisation renouvellent API accès après l’expiration du jeton d’origine. Si demandé, la réponse JSON dans le workflow de mot de passe comprend un jeton d’actualisation. Si vous ne recevez pas de jeton d’actualisation, créez-en un via le 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 workflow d’utilisation d’un jeton d’actualisation pour créer un jeton d’accès à partir d’un client JSON dans votre navigateur.

Étape 1 : demander le nouveau jeton

Transmettez une demande de jeton d’actualisation au client JSON de votre choix. Lorsque vous créez la requête :

• Utilisez une méthode POST pour appeler https://api.demdex.com/oauth/token.
• Convertissez votre identifiant client et votre secret en une chaîne codée en base-64. Séparez l’ID et le secret par deux points pendant le processus de conversion. Par exemple, les informations d’identification testId : testSecret converties en dGVzdElkOnRlc3RTZWNyZXQ=.
• Transmettez les en-têtes HTTP Authorization:Basic <base-64 clientID:clientSecret> et Content-Type: application/x-www-form-urlencoded. Par exemple, votre en-tête pourrait ressembler à ceci :
  Authorization: Basic dGVzdElkOnRlc3RTZWNyZXQ=
Content-Type: application/x-www-form-urlencoded
• Dans le corps de la requête, spécifiez le 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 : recevoir le nouveau jeton

La réponse JSON contient votre nouveau jeton d’accès. La réponse doit se présenter comme suit :

{
    "access_token": "4fdfc261-2ffc-4fb7-8dbd-64221714c45f",
    "token_type": "bearer",
    "refresh_token": "295fa487-1825-4caa-a715-80b81ac17dae",
    "expires_in": 21922,
    "scope": "read write"
}

Code d’autorisation et authentification implicite authentication-code-implicit

Le Audience Manager REST API prend en charge le code d’autorisation et l’authentification implicite. Pour utiliser ces méthodes d’accès, vos utilisateurs doivent se connecter à https://api.demdex.com/oauth/authorize pour obtenir des jetons d’accès et d’actualisation.