Platform Guía de preguntas frecuentes y solución de problemas

Este documento proporciona respuestas a las preguntas más frecuentes acerca de 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 Experience Platform API. Para obtener guías de solución de problemas sobre Platform servicios, consulte la directorio de solución de problemas de servicios más abajo.

Preguntas frecuentes faq

A continuación se muestra una lista de respuestas a las preguntas frecuentes acerca de Adobe Experience Platform.

Qué son Experience Platform ¿API? what-are-experience-platform-apis

Experience Platform ofrece varias API RESTful que utilizan solicitudes HTTP para acceder a Platform recursos. Cada una de estas API de servicio expone varios extremos y le permite realizar operaciones para enumerar (GET), buscar (GET), editar (PUT o PATCH) y eliminar (DELETE) 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? how-do-i-format-an-api-request

Los formatos de solicitud varían en función del Platform API en uso. La mejor manera de aprender a estructurar las llamadas de API es siguiendo junto con los ejemplos proporcionados en la documentación de la aplicación en particular Platform servicio que está utilizando.

Para obtener más información sobre el formato de solicitudes de API, visite la Guía de introducción a la API de Platform leer llamadas de API de muestra sección.

¿Cuál es mi organización? what-is-my-ims-organization

Una organización es una representación de Adobe de un cliente. Cualquier solución de Adobe con licencia está integrada con esta organización del cliente. Cuando una organización tenga derecho a Experience Platform, puede asignar acceso a los desarrolladores. El ID de organización (x-gw-ims-org-id) representa la organización para la que se debe ejecutar una llamada a la API y, por lo tanto, es necesaria como encabezado en todas las solicitudes de API. Este ID se puede encontrar a través de la variable Consola de Adobe Developer: en el Integraciones , vaya a la pestaña Información general para que cualquier integración en particular encuentre el ID en Credenciales del cliente. Para obtener un tutorial paso a paso sobre cómo autenticarse en Platform, consulte la tutorial de autenticación.

¿Dónde puedo encontrar mi clave de API? where-can-i-find-my-api-key

Se requiere una clave de API como encabezado en todas las solicitudes de API. Se puede encontrar a través de la Consola de Adobe Developer. En la consola, en 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 un tutorial paso a paso sobre cómo autenticarse en Platform, consulte la tutorial de autenticación.

¿Cómo obtengo un token de acceso? how-do-i-get-an-access-token

Se requieren tokens de acceso en el encabezado Autorización de todas las llamadas a la API. Se pueden generar mediante un comando CURL, siempre que tenga acceso a una integración para una organización. Los tokens de acceso solo son válidos durante 24 horas, después de lo cual se debe generar un nuevo token para seguir utilizando la API. Para obtener más información sobre la generación de tokens de acceso, consulte la tutorial de autenticación.

¿Cómo se utilizan los parámetros de consulta? how-do-i-user-query-parameters

Algunos Platform Los extremos de la 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 anexan a las rutas de solicitud con un signo de interrogación (?), seguido de uno o más parámetros de consulta utilizando el formato paramName=paramValue. Cuando se combinan varios parámetros en una sola llamada, se debe utilizar un signo & (&) 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 utilizados 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? how-do-i-indicate-a-json-field-to-update-in-a-patch-request

Muchas operaciones del PATCH en Platform Las API utilizan Puntero JSON cadenas para indicar las propiedades JSON que se van a actualizar. Normalmente se incluyen en las cargas útiles de solicitud utilizando Parche de JSON formato. Consulte la Guía de aspectos básicos de API para obtener información detallada sobre la sintaxis necesaria para estas tecnologías.

¿Puedo usar Postman para hacer llamadas a Platform ¿API? how-do-i-use-postman-to-make-calls-to-platform-apis

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

Requisitos del sistema para Platform? what-are-the-system-requirements-for-platform

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

Para operaciones basadas en IU:

Para interacciones de API y desarrollador:

Errores y solución de problemas errors-and-troubleshooting

A continuación se muestra una lista de errores que pueden producirse al utilizar cualquier Experience Platform servicio. Para obtener guías de solución de problemas sobre Platform servicios, consulte la directorio de solución de problemas de servicios más abajo.

Códigos de estado de API api-status-codes

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

Errores de encabezado de solicitud request-header-errors

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

Falta el token de OAuth oauth-token-is-missing

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

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

El token de OAuth no es válido oauth-token-is-not-valid

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

Este mensaje de error se muestra cuando el token de acceso proporcionado 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 de Adobe I/O.

La clave API es obligatoria api-key-is-required

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

Este mensaje de error se muestra cuando 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 intentarlo de nuevo.

Clave de API no válida api-key-is-invalid

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

Falta el encabezado missing-header

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

Este mensaje de error se muestra cuando un encabezado de organización (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 antes de intentarlo de nuevo.

El perfil no es válido profile-is-not-valid

{
    "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 (identificados por el token de acceso en el Authorization encabezado) no puede realizar llamadas a Experience Platform API para la organización proporcionadas en x-gw-ims-org-id encabezado. Asegúrese de haber proporcionado el ID correcto para su organización 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 el Integraciones , vaya a la pestaña Información general para una integración específica en la que buscar el ID Credenciales del cliente.

Error de actualización de etiqueta refresh-etag-error

{
"errorMessage":"Supplied version=[\\\\\\\"a200a2a3-0000-0200-0000-123178f90000\\\\\\\"] does not match the current version on entity=[\\\\\\\"a200cdb2-0000-0200-0000-456179940000\\\\\\\"]"
}

Puede recibir un error de etiqueta si otro llamador de API realizó un cambio en cualquier entidad de origen o destino, como flujo, conexión, conector de origen o conexión de destino. Debido a la falta de coincidencia de versiones, el cambio que intenta realizar no se aplicaría a la última versión de la entidad.

Para resolver esto, debe recuperar la entidad de nuevo, asegurarse de que los cambios son compatibles con la nueva versión de la entidad y, a continuación, colocar la nueva etiqueta en If-Match y finalmente realice la llamada de API de.

Tipo de contenido válido no especificado valid-content-type-not-specified

{
    "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 que su valor es application/json.

Falta la región del usuario user-region-is-missing

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

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

Directorio de resolución de problemas del servicio service-troubleshooting-directory

A continuación se muestra una lista de guías de solución de problemas y documentación de referencia de la 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 individuo Platform servicios. Los documentos de referencia de la API proporcionan una guía completa de todos los extremos disponibles para cada servicio y muestran cuerpos de solicitudes, respuestas y códigos de error de muestra que puede recibir.