Interfaz de la API

El Interfaz de API es una representación de la API de ExoClick diseñada para detallar las solicitudes disponibles, sus parámetros asociados y sus respuestas esperadas. Puedes verla desde el Panel de Administración.

Todas las solicitudes de la API se enumeran bajo su grupo asociado.

Para acceder a las solicitudes restringidas de la API, debe haber un Token de sesión establecido. Para establecer un token, debes tener una cuenta válida con el nombre de usuario y la contraseña requeridos o un token de API. Haz clic en el Iniciar sesión botón en la parte superior derecha de la pantalla e introduce tu nombre de usuario y contraseña o proporciona un token de API. Después de hacer clic en el Iniciar sesión botón, se enviará una solicitud de inicio de sesión a la API para recuperar un token de sesión válido. Luego, este token se usará para validar todas las solicitudes de API que desees realizar en esa sesión.

Para hacer una solicitud a la API, haz clic en un grupo. El grupo se expandirá para mostrar las solicitudes disponibles. Haz clic de nuevo en la solicitud deseada. Se expandirá un panel con los detalles de la solicitud.

• El Cuerpo de la respuesta, si lo hay, se mostrará primero junto con la respuesta Tipo de contenido.
• El Parámetros de la solicitud, obligatorios y/o opcionales, se detallan a continuación, junto con la solicitud Tipo de contenido, si es necesario.
• Esperado Mensajes de respuesta se enumeran a continuación.
• Para hacer la solicitud, completa los parámetros requeridos. Si el cuerpo de la solicitud está detallado, al hacer clic en el cuerpo en la ventana de Modelo se rellenará previamente la ventana de parámetros con el cuerpo.
• Una vez que se hayan establecido todos los parámetros requeridos, al hacer clic en el Probar botón se ejecutará la solicitud.
• Aparecerán cuatro paneles debajo del botón:

  • El primero muestra la URL de la solicitud.
  • El segundo detalla el Cuerpo de la respuesta.
  • El tercero detalla el Código de respuesta.
  • El cuarto detalla los Encabezados de la respuesta.