Introducción a REST APIs getting-started-with-rest-apis

Información general de Adobe Developer adobeio

Adobe Developer es el ecosistema y la comunidad de desarrolladores de Adobe. Incluye API para todos los productos de Adobe.

Esta es la forma recomendada de configurar y usar Adobe APIs.

Requisitos previos prerequisites

Antes de configurar la autenticación de JWT, asegúrate de tener acceso a Adobe Developer Console en Adobe Developer. Póngase en contacto con el administrador de su organización para solicitudes de acceso.

Autenticación auth

Siga los pasos a continuación para configurar la autenticación de JWT (Service Account) mediante Adobe Developer:

1. Inicie sesión en Adobe Developer Console.
2. Siga los pasos de Conexión de cuenta de servicio.
   • Durante Paso 2: Agregue una API al proyecto mediante la autenticación de cuenta de servicio, elija la opción Audience Manager API.
3. Pruebe la conexión realizando la primera llamada de API según las instrucciones del Paso 3.

Permisos de RBAC de cuenta técnica

Si su cuenta de Audience Manager usa Control de acceso basado en roles, debe crear una cuenta de usuario técnico de Audience Manager y agregarla al grupo RBAC de Audience Manager que realizará las llamadas de API.

Siga los pasos a continuación para crear una cuenta de usuario técnica y agregarla a un grupo RBAC:

1. Realizar una llamada de GET a https://aam.adobe.io/v1/users/self. La llamada creará una cuenta de usuario técnica que podrá ver en Admin Console, en la página Users.

   

2. Inicie sesión en su cuenta de Audience Manager y agregue la cuenta de usuario técnico al grupo de usuarios que realizará las llamadas de API.

Audience Manager REST API sigue OAuth 2.0 estándares para la autenticación y renovación de tokens. Las secciones siguientes describen cómo autenticarse y comenzar a trabajar con API.

Crear un usuario API genérico requirements

Le recomendamos que cree una cuenta de usuario técnica independiente para trabajar con Audience Manager APIs. Se trata de una cuenta genérica que no está vinculada a un usuario específico de su organización ni asociada a él. Este tipo de cuenta de usuario API le ayuda a lograr dos cosas:

• Identifique qué servicio está llamando a API (por ejemplo, llamadas de sus aplicaciones que usan nuestros APIs o de otras herramientas que realizan API solicitudes).
• Proporcione acceso ininterrumpido a API. Una cuenta vinculada a una persona específica puede eliminarse cuando abandone la compañía. Esto evitará que trabaje con el código API disponible. Una cuenta genérica que no esté vinculada a un empleado en particular le ayuda a evitar este problema.

Como ejemplo o caso de uso para este tipo de cuenta, supongamos que desea cambiar muchos segmentos a la vez con las herramientas de administración masiva. Para ello, su cuenta de usuario necesita el acceso de API. En lugar de agregar permisos a un usuario específico, cree una cuenta de usuario API no específica que tenga las credenciales, la clave y el secreto adecuados para realizar llamadas a API. Esto también resulta útil si desarrolla sus propias aplicaciones que utilizan Audience Manager APIs.

Póngase en contacto con el consultor de Audience Manager para configurar una cuenta de usuario genérica de solo API.

Flujo de trabajo de autenticación de contraseña password-authentication-workflow

Autenticación de contraseña: acceso seguro a REST API. Los pasos siguientes describen el flujo de trabajo para la autenticación mediante contraseña desde un cliente de JSON en su explorador.

Paso 1: Solicitar acceso de API

Póngase en contacto con su administrador de Soluciones para socios. Proporcionarán un ID de cliente API y un secreto. El identificador y secreto le autentican en API.

Nota: Si desea recibir un token de actualización, especifíquelo cuando solicite acceso a API.

Paso 2: Solicitar el token

Pase una solicitud de token con su cliente JSON preferido. Cuando genere la solicitud:

• Use un método POST para llamar a https://api.demdex.com/oauth/token.
• Convierta su ID de cliente y secreto en una cadena codificada en base 64. Separe el ID y el secreto con dos puntos durante el proceso de conversión. Por ejemplo, las credenciales testId : testSecret se convierten en dGVzdElkOnRlc3RTZWNyZXQ=.
• Pasar HTTP headers Authorization:Basic <base-64 clientID:clientSecret> y Content-Type: application/x-www-form-urlencoded Por ejemplo, el encabezado podría tener el aspecto siguiente:
  Authorization: Basic dGVzdElkOnRlc3RTZWNyZXQ=
Content-Type: application/x-www-form-urlencoded
• Configure el cuerpo de la solicitud de la siguiente manera:
  
  grant_type=password&username=<your-AudienceManager-user-name>&password=<your-AudienceManager-password>

Paso 3: Recibir el token

La respuesta JSON contiene su token de acceso. La respuesta debería ser similar a la siguiente:

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

La clave expires_in representa el número de segundos hasta que caduca el token de acceso. Se recomienda utilizar tiempos de caducidad cortos para limitar la exposición si el token se expone en algún momento.

Actualizar token refresh-token

Actualizar tokens renovar el acceso de API después de que caduque el token original. Si se solicita, la respuesta JSON en el flujo de trabajo de contraseñas incluye un token de actualización. Si no recibe un token de actualización, cree uno nuevo mediante el proceso de autenticación de contraseña.

También puede utilizar un token de actualización para generar un nuevo token antes de que caduque el token de acceso existente.

Si su token de acceso ha caducado, recibirá un 401 Status Code y el siguiente encabezado en la respuesta:

WWW-Authenticate: Bearer realm="oauth", error="invalid_token", error_description="Access token expired: <token>"

Los siguientes pasos describen el flujo de trabajo para usar un token de actualización con el fin de crear un nuevo token de acceso a partir de un cliente JSON en el explorador.

Paso 1: Solicitar el nuevo token

Pase una solicitud de token de actualización con su cliente JSON preferido. Cuando genere la solicitud:

• Use un método POST para llamar a https://api.demdex.com/oauth/token.
• Convierta su ID de cliente y secreto en una cadena codificada en base 64. Separe el ID y el secreto con dos puntos durante el proceso de conversión. Por ejemplo, las credenciales testId : testSecret se convierten en dGVzdElkOnRlc3RTZWNyZXQ=.
• Pase los encabezados HTTP Authorization:Basic <base-64 clientID:clientSecret> y Content-Type: application/x-www-form-urlencoded. Por ejemplo, el encabezado podría tener el aspecto siguiente:
  Authorization: Basic dGVzdElkOnRlc3RTZWNyZXQ=
Content-Type: application/x-www-form-urlencoded
• En el cuerpo de la solicitud, especifique grant_type:refresh_token y pase el token de actualización que recibió en su solicitud de acceso anterior. La solicitud debe tener este aspecto:
  grant_type=refresh_token&refresh_token=b27122c0-b0c7-4b39-a71b-1547a3b3b88e

Paso 2: Recibir el nuevo token

La respuesta JSON contiene su nuevo token de acceso. La respuesta debería ser similar a la siguiente:

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

Código de autorización y autenticación implícita authentication-code-implicit

Audience Manager REST API admite código de autorización y autenticación implícita. Para usar estos métodos de acceso, los usuarios deben iniciar sesión en https://api.demdex.com/oauth/authorize para obtener acceso y actualizar los tokens.