API Interface
La Interfaz API es una representación de la API de ExoClick diseñada para detallar las solicitudes disponibles, sus parámetros asociados y las respuestas esperadas. Puede consultarla desde el Panel de administración.
Todas las solicitudes de API aparecen en su grupo asociado.
Para acceder a las solicitudes de API restringidas, debe haber un token de sesión establecido. Para establecer un token, debe tener una cuenta válida con el nombre de usuario y la contraseña requeridos o un token de API. Haga clic en el botón Iniciar sesión en la parte superior derecha de la pantalla e introduzca su nombre de usuario y contraseña o proporcione un token de API. Después de hacer clic en el botón Iniciar sesión, se realizará una solicitud de inicio de sesión a la API para recuperar un testigo de sesión válido. Este token se utilizará para validar todas las solicitudes de API que desee realizar en esa sesión.
Para realizar una solicitud a la API, haga clic en un grupo. El grupo se expandirá para listar las solicitudes disponibles. Haga clic de nuevo en la solicitud deseada. Se abrirá un panel con los detalles de la solicitud.
El cuerpo de la respuesta, si existe, se mostrará en primer lugar junto al Content-type de la respuesta.
Los parámetros de solicitud, obligatorios y/u opcionales, se detallan a continuación, junto con el Content-type de la solicitud, si es necesario.
A continuación, se enumeran los mensajes de respuesta esperados.
Para realizar la solicitud, rellene los parámetros requeridos. Si se detalla el cuerpo de la solicitud, al hacer clic en el cuerpo en la ventana Modelo se rellenará previamente la ventana de parámetros con el cuerpo.
Una vez configurados todos los parámetros necesarios, pulse el botón Pruébelo para ejecutar la solicitud.
Debajo del botón aparecerán cuatro paneles:
- La primera muestra la URL de solicitud completa.
- El segundo detalla el cuerpo de la respuesta.
- El tercero detalla el Código de respuesta.
- El cuarto detalla las Cabeceras de respuesta.