Platform Preguntas más frecuentes y guía de solución de problemas

Este documento proporciona respuestas a las preguntas más frecuentes sobre Adobe Experience Platform, así como una guía de solución de problemas de alto nivel para los errores comunes que se pueden encontrar en cualquier API Experience Platform. Para obtener guías de solución de problemas sobre servicios Platform individuales, consulte el directorio de solución de problemas del servicio a continuación.

Preguntas más frecuentes

La siguiente es una lista de respuestas a las preguntas más frecuentes sobre Adobe Experience Platform.

¿Qué son las Experience Platform API?

Experience Platform oferta varias API de RESTful que utilizan solicitudes HTTP para acceder a Platform los recursos. Cada una de estas API de servicio expone varios extremos y le permite realizar operaciones de lista (GET), búsqueda (GET), edición (PUT y/o PATCH) y eliminación (DELETE) de recursos. Para obtener más información sobre los extremos específicos y las operaciones disponibles para cada servicio, consulte la documentación de referencia de API en Adobe I/O.

¿Cómo se formatea una solicitud de API?

Los formatos de solicitud varían según la API Platform que se esté utilizando. La mejor manera de aprender a estructurar las llamadas de API es siguiendo los ejemplos que se proporcionan en la documentación del servicio Platform concreto que está utilizando.

Leer llamadas de API de ejemplo

La documentación de Experience Platform muestra las llamadas de API de ejemplo de dos maneras diferentes. En primer lugar, la llamada se presenta en su formato de API, una representación de plantilla que muestra únicamente la operación (GET, POST, PUT, PATCH, DELETE) y el punto final que se utiliza (por ejemplo, /global/classes). Algunas plantillas también muestran la ubicación de las variables para ilustrar cómo se debe formular una llamada, como GET /{VARIABLE}/classes/{ANOTHER_VARIABLE}.

Las llamadas se muestran luego como comandos cURL en una Solicitud, que incluye los encabezados necesarios y la "ruta de acceso base" completa necesaria para interactuar correctamente con la API. La ruta de acceso base se debe anteponer a todos los extremos. Por ejemplo, el punto final /global/classes antes mencionado pasa a ser https://platform.adobe.io/data/foundation/schemaregistry/global/classes. Verá el formato de API / patrón de solicitud en toda la documentación y se espera que utilice la ruta completa que se muestra en la solicitud de ejemplo al realizar sus propias llamadas a las API de plataforma.

Ejemplo de solicitud de API

A continuación se muestra un ejemplo de solicitud de API que muestra el formato que encontrará en la documentación.

Formato API

El formato de la API muestra la operación (GET) y el punto final que se está utilizando. Las variables se indican mediante llaves (en este caso, {CONTAINER_ID}).

GET /{CONTAINER_ID}/classes

Solicitud

En esta solicitud de ejemplo, las variables del formato de API reciben valores reales en la ruta de solicitud. También se muestran todos los encabezados requeridos, ya sea valores de encabezado de ejemplo o variables en las que se debe incluir información confidencial (como tokens de seguridad e ID de acceso).

curl -X GET \
  https://platform.adobe.io/data/foundation/schemaregistry/global/classes \
  -H 'Accept: application/vnd.adobe.xed-id+json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Respuesta

La respuesta ilustra lo que esperaría recibir tras una llamada correcta a la API, según la solicitud que se envió. Ocasionalmente, la respuesta se trunca en el espacio, lo que significa que puede ver más información o información adicional a la que se muestra en la muestra.

{
    "results": [
        {
            "title": "XDM ExperienceEvent",
            "$id": "https://ns.adobe.com/xdm/context/experienceevent",
            "meta:altId": "_xdm.context.experienceevent",
            "version": "1"
        },
        {
            "title": "XDM Individual Profile",
            "$id": "https://ns.adobe.com/xdm/context/profile",
            "meta:altId": "_xdm.context.profile",
            "version": "1"
        }
    ],
    "_links": {}
}

Para obtener más información sobre los extremos específicos en las API de plataforma, incluidos los encabezados y los cuerpos de solicitud requeridos, consulte la documentación de referencia de API.

¿Cuál es mi organización IMS?

Una organización de IMS es una representación Adobe de un cliente. Cualquier solución de Adobe con licencia se integra con esta organización de clientes. Cuando una organización de IMS tiene derecho a Experience Platform, puede asignar acceso a los programadores. El identificador de organización de IMS (x-gw-ims-org-id) representa la organización para la que se debe ejecutar una llamada de API y, por lo tanto, se requiere como encabezado en todas las solicitudes de API. Este ID se puede encontrar a través de la Consola de programadores de Adobe: en la ficha Integraciones, navegue a la sección Información general para cualquier integración en particular a fin de encontrar el ID en Credenciales de cliente. Para obtener un tutorial paso a paso sobre cómo autenticarse en Platform, consulte el tutorial de autenticación.

¿Dónde puedo encontrar mi clave de API?

Se requiere una clave de API como encabezado en todas las solicitudes de API. Se puede encontrar a través de la Consola de programadores de Adobe. Dentro de la consola, en la ficha Integrations, navegue a la sección Overview para obtener una integración específica y encontrará la clave en Client Credentials. Para obtener un tutorial paso a paso sobre cómo autenticarse en Platform, consulte el tutorial de autenticación.

¿Cómo consigo un token de acceso?

Se requieren tokenes de acceso en el encabezado Autorización de todas las llamadas de API. Se pueden generar mediante un comando curl, siempre que tenga acceso a una integración para una organización de IMS. Las tokenes de acceso solo son válidas durante 24 horas, tras las cuales se debe generar un nuevo token para continuar usando la API. Para obtener más información sobre la generación de tokenes de acceso, consulte el tutorial de autenticación.

¿Cómo se utilizan los parámetros de consulta?

Algunos extremos de API Platform aceptan parámetros de consulta para localizar información específica y filtrar los resultados devueltos en la respuesta. Los parámetros de consulta se anexan a las rutas de solicitud con un signo de interrogación (?), seguido de uno o más parámetros de consulta con el formato paramName=paramValue. Al combinar varios parámetros en una sola llamada, debe utilizar un símbolo de unión (&) para separar parámetros individuales. En el siguiente ejemplo se muestra cómo se representa en la documentación una solicitud que utiliza varios parámetros de consulta.

Algunos ejemplos de parámetros de consulta que se utilizan con frecuencia son:

GET /tenant/schemas?orderby=title
GET /datasets?limit=36&start=10
GET /batches?createdAfter=1559775880000&orderBy=desc:created

Para obtener información detallada sobre los parámetros de consulta disponibles para un servicio o extremo específico, consulte la documentación específica del servicio.

¿Cómo se indica un campo JSON para actualizar en una solicitud de PATCH?

Muchas operaciones de PATCH en Platform API utilizan cadenas JSON Pointer para indicar las propiedades de JSON que se van a actualizar. Normalmente, se incluyen en las cargas de solicitud con el formato JSON Patch. Consulte la guía de principios de API para obtener información detallada sobre la sintaxis requerida para estas tecnologías.

¿Puedo usar Postman para realizar llamadas a Platform API?

Postmanis es una herramienta útil para visualizar llamadas a las API de RESTful. Esta publicación media describe cómo configurar Postman para que realice automáticamente la autenticación y la utilice para consumir Experience Platform API.

¿Cuáles son los requisitos del sistema para Platform?

Según si utiliza la interfaz de usuario o la API, se aplican los siguientes requisitos del sistema:

Para operaciones basadas en la interfaz de usuario:

  • Un navegador web moderno y estándar. Aunque se recomienda la versión más reciente de Chrome, también se admiten las versiones principales actuales y anteriores de Firefox, Internet Explorer y Safari.
    • Cada vez que se lanza una nueva versión principal, se eliminan los inicios Platform que admiten la versión más reciente y la compatibilidad con la tercera versión más reciente.
  • Todos los exploradores deben tener habilitadas las cookies y JavaScript.

Para interacciones entre API y desarrollador:

  • Un entorno de desarrollo para desarrollar integraciones de REST, flujo continuo y Weblink.

Errores y solución de problemas

La siguiente es una lista de errores que puede encontrar al utilizar cualquier servicio Experience Platform. Para obtener guías de solución de problemas sobre servicios Platform individuales, consulte el directorio de solución de problemas del servicio a continuación.

Códigos de estado de API

Los siguientes códigos de estado pueden encontrarse en cualquier API Experience Platform. Cada uno de ellos tiene una variedad de causas, por lo que las explicaciones dadas en esta sección son de carácter general. Para obtener más información acerca de los errores específicos en los servicios Platform individuales, consulte el directorio de solución de problemas del servicio a continuación.

Código de estado Descripción Causas posibles
400 Solicitud incorrecta La solicitud se construyó incorrectamente, falta información de clave o contenía sintaxis incorrecta.
401 Error de autenticación La solicitud no pasó una comprobación de autenticación. Es posible que falte el token de acceso o que no sea válido. Consulte la sección Errores de token de OAuth para obtener más información.
403 Prohibido Se encontró el recurso, pero no tiene las credenciales correctas para vista.
404 No encontrado No se encontró el recurso solicitado en el servidor. Es posible que el recurso se haya eliminado o que la ruta solicitada se haya introducido incorrectamente.
500 Error interno del servidor Se trata de un error del lado del servidor. Si realiza muchas llamadas simultáneas, puede que esté llegando al límite de la API y necesite filtrar los resultados. (Para obtener más información, consulte la Catalog Service guía para desarrolladores de API sobre filtrado de datos.) Espere un momento antes de volver a intentar la solicitud y póngase en contacto con el administrador si el problema persiste.

Errores de encabezado de solicitud

Todas las llamadas de API de Platform requieren encabezados de solicitud específicos. Para ver qué encabezados son necesarios para servicios individuales, consulte la documentación de referencia de API. Para buscar los valores de los encabezados de autenticación requeridos, consulte el tutorial de autenticación. Si alguno de estos encabezados falta o no es válido al realizar una llamada de API, pueden producirse los siguientes errores.

Falta el token de OAuth

{
    "error_code": "403010",
    "message": "Oauth token is missing."
}

Este mensaje de error se muestra cuando falta un encabezado Authorization en una solicitud de API. Asegúrese de que el encabezado Autorización se incluye con un token de acceso válido antes de intentarlo de nuevo.

El token de OAuth no es válido

{
    "error_code": "401013",
    "message": "Oauth token is not valid"
}

Este mensaje de error se muestra cuando el token de acceso proporcionado en el encabezado Authorization no es válido. Asegúrese de que el token se ha introducido correctamente o genera un nuevo token en la consola de Adobe I/O.

Se requiere la clave de API

{
    "error_code": "403000",
    "message": "Api Key is required"
}

Este mensaje de error se muestra cuando falta un encabezado de clave de API (x-api-key) en una solicitud de API. Asegúrese de que el encabezado se incluye con una clave de API válida antes de intentarlo de nuevo.

La clave de API no es válida

{
    "error_code": "403003",
    "message": "Api Key is invalid"
}

Este mensaje de error se muestra cuando el valor del encabezado de clave de API proporcionado (x-api-key) no es válido. Asegúrese de haber introducido la clave correctamente antes de intentarlo de nuevo. Si no conoce la clave de API, puede encontrarla en la Consola de Adobe I/O: en la ficha Integraciones, vaya a la sección Información general para obtener una integración específica para encontrar la clave de API en Credenciales de cliente.

Falta el encabezado

{
    "error_code": "400003",
    "message": "Missing header"
}

Este mensaje de error se muestra cuando falta un encabezado de organización de IMS (x-gw-ims-org-id) en una solicitud de API. Asegúrese de que el encabezado se incluye con el ID de su organización de IMS antes de intentarlo de nuevo.

Perfil no válido

{
    "error_code": "403025",
    "message": "Profile is not valid"
}

Este mensaje de error se muestra cuando el usuario o la integración de Adobe I/O (identificada por el token de acceso en el encabezado Authorization) no tiene derecho a realizar llamadas a Experience Platform API para la organización IMS proporcionada en el encabezado x-gw-ims-org-id. Asegúrese de que ha proporcionado el ID correcto para su organización de IMS en el encabezado antes de intentarlo de nuevo. Si no conoce su ID de organización, puede encontrarlo en la Consola de Adobe I/O: en la ficha Integraciones, vaya a la sección Información general para obtener una integración específica y busque el ID en Credenciales de cliente.

No se especificó un tipo de contenido válido

{
    "type": "/placeholder/type/uri",
    "status": 400,
    "title": "BadRequestError",
    "detail": "A valid content-type must be specified"
}

Este mensaje de error se muestra cuando una solicitud de POST, PUT o PATCH tiene un encabezado no válido o falta Content-Type. Asegúrese de que el encabezado esté incluido en la solicitud y de que su valor sea application/json.

Directorio de solución de problemas del servicio

La siguiente es una lista de guías de solución de problemas y documentación de referencia de API para las API Experience Platform. Cada guía de solución de problemas proporciona respuestas a las preguntas más frecuentes y soluciones a problemas específicos de los servicios individuales Platform. Los documentos de referencia de API proporcionan una guía completa de todos los extremos disponibles para cada servicio y muestran los cuerpos de solicitud de muestra, las respuestas y los códigos de error que puede recibir.

Service Referencia de API Resolución de problemas
Control de acceso API de control de acceso Guía de solución de problemas de control de acceso
Adobe Experience Platform Data Ingestion Data Ingestion API Guía de resolución de problemas de ingestión por lotes

Guía de solución de problemas de ingestión por flujo continuo
Adobe Experience Platform Data Science Workspace Sensei Machine Learning API Data Science Workspace guía de solución de problemas
Administración de datos de Adobe Experience Platform Policy Service API
Servicio de ID de Adobe Experience Platform Identity Service API Identity Service guía de solución de problemas
Servicio de Consulta de Adobe Experience Platform Query Service API Query Service guía de solución de problemas
Segmentación de Adobe Experience Platform Segmentation API
Catalog Service Catalog Service API
Experience Data Model (XDM) Schema Registry API XDM System Preguntas más frecuentes y guía de solución de problemas
Flow Service (Sources y Destinations) Flow Service API
Real-time Customer Profile Real-time Customer Profile API Profile guía de solución de problemas
Entornos aislados API de Simulador para pruebas Guía de solución de problemas de Simuladores para pruebas

En esta página

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free