Por toroalbert
Publicado el 13 de Marzo del 2023
Este POST te permitirá consultar los datos de cualquier menú creado utilizando su alias como referencia dentro de la URL a la que se consulta.
Endpoint
GET https://shortae.com/api/{alias-de-menu}
Parámetros
u (obligatorio): Token de usuario utilizado para autenticar la solicitud, que se envía mediante autenticación básica (-u) en el comando curl.access_token (obligatorio): Token de acceso necesario para la solicitud, que se envía como un parámetro mediante el comando curl.XML (opcional): Si se agrega esta variable a la consulta, en vez de recibir la respuesta en formato JSON, se recibirá en formato XML.debug (opcional): 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 (opcional): Si se utiliza esta variable, se buscará en los datos del menú para asegurarse de que contenga lo indicado.UserApi (opcional): Si se utiliza esta variable, se puede evitar enviar el usuario en la autenticación con la opción -u del comando curl.PasswordApi (opcional): Si se utiliza esta variable, se puede evitar enviar la contraseña en la autenticación con la opción -u del comando curl.orden y order (opcional): Ambas variables son por defecto ascendentes "ASC". Si se envía DESC, la consulta será descendente.aordenar y orderby (opcional): Se utilizan para señalar el campo del menú por el cual se desea ordenar la consulta.desde y limite (opcional): 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.
Respuesta
La respuesta es un objeto JSON con las siguientes claves:
success: Indica si la solicitud tuvo éxito.answer: Contiene los datos del menú consultado.Ejemplo
curl -X GET 'https://shortae.com/api/{alias-de-menu}?XML&search=valor-buscado&orden=DESC&aordenar=nombre-campo&limite=10&desde=20' \
-u "{token-de-usuario}:" \
-d access_token="Your access_token"
Es importante que adaptes este ejemplo a tu API específica, incluyendo el alias de menú y los parámetros necesarios. Además, recuerda que debes incluir el token de acceso (access_token) en la consulta, el cual se obtiene utilizando la función Authentication del API.