¿Cómo se da formato a una solicitud de API?
Los formatos de solicitud varían según la API Platform que se utilice. La mejor manera de aprender a estructurar las llamadas de API es siguiendo los ejemplos proporcionados en la documentación del servicio Platform en particular que está utilizando.
Para obtener más información sobre cómo dar formato a las solicitudes de API, visite la sección Guía de introducción a la API de Platform leyendo llamadas de API de ejemplo.
¿Cuál es mi organización?
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 tiene derecho a Experience Platform, puede asignar acceso a los desarrolladores. El identificador de organización (x-gw-ims-org-id
) representa la organización para la que se debe ejecutar una llamada de API y, por lo tanto, es necesario como encabezado en todas las solicitudes de API. Este identificador se puede encontrar a través de Adobe Developer Console: en la ficha Integraciones, vaya a la sección Información general para que cualquier integración en particular encuentre el identificador en Credenciales del 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 Adobe Developer Console. En la consola, en la ficha Integraciones, vaya a la sección 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 el tutorial de autenticación.
¿Cómo obtengo un token de acceso?
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 cómo generar tokens 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 signo & (&
) para separar los 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?
Muchas operaciones del PATCH en las API Platform utilizan cadenas del puntero JSON para indicar que se actualizarán las propiedades JSON. Normalmente se incluyen en las cargas útiles de solicitud utilizando el formato JSON Patch. Consulte la guía de aspectos básicos de la API para obtener información detallada sobre la sintaxis necesaria para estas tecnologías.
¿Puedo usar Postman para hacer llamadas a las API de Platform?
Postman es una herramienta útil para visualizar llamadas a API RESTful. La guía de introducción a la API de Platform contiene un vídeo con instrucciones para importar colecciones de 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 IU:
- Un navegador web estándar y moderno. 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, Platform comienza a admitir la versión más reciente, mientras que se abandona la compatibilidad con 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, streaming y webhook.