En las consultas del API de nuestro administrador, se pueden utilizar las siguientes variables para personalizar los resultados:
Variables
- XML: Si se agrega esta variable a la consulta, en vez de recibir la respuesta en formato JSON, se recibirá en formato XML.
- debug: Si se agrega esta variable a la consulta, se imprimirá la respuesta usando la función var_dump(), para ayudar en la depuración del código.
- search: Si se utiliza esta variable, se buscará en los datos del menú para asegurarse de que contenga lo indicado.
- UserApi: Si se utiliza esta variable, se puede evitar enviar el usuario en la autenticación con la opción -u del comando curl.
- PasswordApi: Si se utiliza esta variable, se puede evitar enviar la contraseña en la autenticación con la opción -u del comando curl.
- order y orden: Ambas variables son por defecto ascendentes (ASC). Si se envía DESC, la consulta será descendente.
- orderby y aordenar: Se utilizan para señalar el campo del menú por el cual se desea ordenar la consulta.
- desde y limite: Se utilizan para la paginación de los resultados. Limite indica cuántos datos tendrá la respuesta y desde indica el inicio de la consulta.
Todas estas variables pueden ser enviadas tanto por GET como por POST.
Endpoint
GET/POST https://shortae.com/api/{alias del menú}
Parámetros
- access_token: Token de acceso necesario para todas las próximas solicitudes del API. Se obtiene utilizando la función Authentication del API.
- token: Token de usuario necesario para las solicitudes del API, se obtiene utilizando la funcion Login del API.
Opcionales:
- XML
- debug
- search
- UserApi
- PasswordApi
- order
- orden
- orderby
- aordenar
- desde
- limite
Respuesta
La respuesta es un objeto JSON con los datos del menú solicitado.
Ejemplo
curl https://shortae.com/api/{alias del menú}?XML&search=valor-buscado&orden=DESC&aordenar=nombre-campo&limite=10&desde=20 -u "{token user}:" -d access_token="Your access_token"
En este ejemplo se están utilizando varias variables en la consulta: XML para recibir la respuesta en formato XML, search para buscar un valor específico, orden y aordenar para ordenar la consulta, limite y desde para la paginación.
Recuerda que siempre debes incluir el token de acceso (access_token) en la consulta.