Platform Guía de preguntas frecuentes y 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 detectar errores comunes que se puedan encontrar en cualquier Experience Platform API. Para obtener guías de resolución de problemas en Platform servicios, consulte la directorio de solución de problemas del servicio más abajo.

Preguntas frecuentes

A continuación encontrará una lista de las respuestas a las preguntas más frecuentes sobre Adobe Experience Platform.

¿Qué son los Experience Platform ¿API?

Experience Platform ofrece varias API de RESTful que utilizan solicitudes HTTP para acceder a Platform recursos. Cada una de estas API de servicio expone varios puntos finales 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 el Adobe I/O.

¿Cómo se da formato a una solicitud de API?

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

Para obtener más información sobre el formato de las solicitudes de API, consulte la guía de introducción a la API de plataforma . leer llamadas de API de ejemplo para obtener más información.

¿Qué es mi organización IMS?

Una organización IMS es una representación de Adobe de un cliente. Las soluciones de Adobe con licencia se integran con esta organización de clientes. Cuando una organización de IMS tiene derecho a Experience Platform, puede asignar acceso a los desarrolladores. El ID 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 variable Adobe Developer Console: en el Integraciones , vaya a la pestaña Información general para cualquier integración en particular para encontrar el ID en Credenciales del cliente. Para obtener una guía paso a paso sobre cómo autenticarse en Platform, consulte la 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 del Adobe Developer Console. Dentro de la consola, en la Integraciones , vaya a la pestaña Información general para una integración específica y encontrará la clave en Credenciales del cliente. Para obtener una guía paso a paso de cómo autenticarse en Platform, consulte la tutorial de autenticación.

¿Cómo obtengo un token de acceso?

Los tokens de acceso son necesarios en el encabezado Autorización de todas las llamadas a la API. Pueden generarse mediante un curl siempre que tenga acceso a una integración para una organización de IMS. Los tokens de acceso solo son válidos durante 24 horas, tras lo cual debe generarse un nuevo token para continuar usando la API. Para obtener más información sobre la generación de tokens de acceso, consulte la tutorial de autenticación.

¿Cómo utilizo los parámetros de consulta?

Algunas Platform Los extremos de API 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 agregan a las rutas de solicitud con un signo de interrogación (?), seguido de uno o más parámetros de consulta que utilizan el formato paramName=paramValue. Al combinar varios parámetros en una sola llamada, debe utilizar un símbolo & (&) para separar parámetros individuales. El siguiente ejemplo muestra cómo se representa una solicitud que utiliza varios parámetros de consulta en la documentación.

Algunos ejemplos de parámetros de consulta usados comúnmente 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 qué parámetros de consulta están disponibles para un servicio o extremo específico, consulte la documentación específica del servicio.

¿Cómo puedo indicar un campo JSON para actualizar en una solicitud del PATCH?

Muchas operaciones de PATCH en Platform Uso de API Puntero JSON cadenas para indicar las propiedades JSON que se van a actualizar. Normalmente se incluyen en las cargas de solicitud mediante Parche JSON formato. Consulte la Guía de fundamentos de API para obtener información detallada sobre la sintaxis necesaria para estas tecnologías.

¿Puedo usar Postman para realizar llamadas a Platform ¿API?

Postman es una herramienta útil para visualizar llamadas a las API de RESTful. La variable Guía de introducción a la API de plataforma contiene un vídeo e instrucciones para importar colecciones Postman. Además, se proporciona una lista de colecciones Postman para cada servicio.

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

Dependiendo de 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 estándar y moderno. Mientras que la última versión de Chrome se recomienda, versiones principales actuales y anteriores de Firefox, Internet Explorer, y Safari también son compatibles.
    • Cada vez que se lanza una nueva versión principal, Platform comienza a admitir la versión más reciente y deja de admitirse la tercera versión más reciente.
  • Todos los exploradores deben tener habilitadas las cookies y JavaScript.

Para interacciones de API y desarrollador:

  • Un entorno de desarrollo para desarrollar integraciones de REST, transmisión por secuencias y Weblock.

Errores y solución de problemas

A continuación se muestra una lista de errores que puede encontrar al usar cualquier Experience Platform servicio. Para obtener guías de resolución de problemas en Platform servicios, consulte la directorio de solución de problemas del servicio más abajo.

Códigos de estado de API

Los siguientes códigos de estado se pueden encontrar en cualquier Experience Platform API. Cada uno tiene una variedad de causas, por lo que las explicaciones dadas en esta sección son de naturaleza general. Para obtener más información sobre errores específicos en cada Platform servicios, consulte la directorio de solución de problemas del servicio más abajo.

Código de estado Descripción Posibles causas
400 Solicitud incorrecta La solicitud se ha construido incorrectamente, falta información de clave o contiene sintaxis incorrecta.
401 Error de autenticación La solicitud no pasó una comprobación de autenticación. Puede que falte el token de acceso o que no sea válido. Consulte la Errores de token de OAuth para obtener más información.
403 Prohibido Se encontró el recurso, pero no tiene las credenciales adecuadas para verlo.
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 Este es un error del lado del servidor. Si realiza muchas llamadas simultáneas, es posible que esté alcanzando el límite de la API y tenga que filtrar los resultados. (Consulte la Catalog Service Guía para desarrolladores de API en filtrado de datos para obtener más información). Espere un momento antes de volver a probar la solicitud y póngase en contacto con el administrador si el problema persiste.

Solicitar errores de encabezado

Todas las llamadas de API en 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 necesarios, consulte la Tutorial de autenticación. Si falta alguno de estos encabezados o no es válido al realizar una llamada a la API, pueden producirse los siguientes errores.

Falta el token OAuth

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

Este mensaje de error se muestra cuando Authorization falta el encabezado de una solicitud de API. Asegúrese de que el encabezado Autorización esté incluido 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 se proporciona el token de acceso en la variable Authorization el encabezado no es válido. Asegúrese de que el token se ha introducido correctamente o generar un nuevo token en la consola Adobe I/O.

Se requiere la clave de API

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

Este mensaje de error se muestra cuando se coloca un encabezado de clave de API (x-api-key) no aparece en una solicitud de API. Asegúrese de que el encabezado esté incluido con una clave de API válida antes de volver a intentarlo.

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 volver a intentarlo. Si no conoce su clave de API, puede encontrarla en la Consola Adobe I/O: en el Integraciones , vaya a la pestaña Información general para una integración específica para encontrar la clave de API en Credenciales del cliente.

Falta el encabezado

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

Este mensaje de error aparece cuando hay un encabezado de organización de IMS (x-gw-ims-org-id) no aparece en una solicitud de API. Asegúrese de que el encabezado esté incluido con el ID de su organización IMS antes de intentarlo de nuevo.

El perfil no es válido

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

Este mensaje de error se muestra cuando se integra el usuario o el Adobe I/O (identificado mediante la función token de acceso en el Authorization header) no tiene derecho a realizar llamadas a Experience Platform API para la organización IMS proporcionada en la x-gw-ims-org-id encabezado. Asegúrese de proporcionar el ID correcto para su organización IMS en el encabezado antes de volver a intentarlo. Si no conoce su ID de organización, puede encontrarlo en la Consola Adobe I/O: en el Integraciones , vaya a la pestaña Información general para una integración específica para encontrar el ID en Credenciales del cliente.

No se ha especificado 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 no es válida o falta Content-Type encabezado. Asegúrese de que el encabezado esté incluido en la solicitud y de que su valor sea application/json.

Falta la región del usuario

{
    "error_code": "403027",
    "message": "User region is missing"
}

Este mensaje de error se muestra en cualquiera de los dos casos siguientes:

  • Cuando el encabezado de organización de IMS es incorrecto o está mal formado (x-gw-ims-org-id) se pasa en una solicitud de API. Asegúrese de incluir el ID correcto de su organización de IMS antes de intentarlo de nuevo.
  • Cuando su cuenta (representada por las credenciales de autenticación proporcionadas) no está asociada con un perfil de producto para Experience Platform. Siga los pasos de generación de credenciales de acceso en el tutorial de autenticación de la API de plataforma para agregar Platform a su cuenta y actualizar las credenciales de autenticación en consecuencia.

Directorio de solución de problemas del servicio

A continuación se muestra una lista de guías de solución de problemas y documentación de referencia de API para Experience Platform API. Cada guía de solución de problemas proporciona respuestas a las preguntas más frecuentes y soluciones a problemas específicos de cada Platform servicios. Los documentos de referencia de la 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 del control de acceso
Incorporación de datos de Adobe Experience Platform Data Ingestion API Guía de solución de problemas de ingesta por lotes

Guía de solución de problemas de ingesta de transmisión
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 consultas 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 Guía de preguntas frecuentes y 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 Sandbox Guía de solución de problemas de los Simuladores para pruebas

En esta página