Normas generales

  • La API REST está disponible debajo de la URL base:

/public/external/api

  • Todas las solicitudes deben enviarse mediante POST.
  • La API REST sólo admite solicitudes a través de HTTPS.
  • Las solicitudes deben contener las siguientes cabeceras:
Edita

Nombre de la cabecera



Valor de cabecera



Descripción



Tipo de contenido



aplicación/json



fijo



auth



123…xyz



Clave API desde la pestaña «Acceso API



firma



Firma codificada en Base64



Firma de la carga útil generada con el


Clave privada de la pestaña «Acceso API


  • El cuerpo de la solicitud debe ser un objeto codificado json que debe contener los siguientes valores:
Edita

Campo



Campo Ejemplo Valor



Descripción



api



v2/dispositivo/listadispositivos



Nombre de la API



tiempo



1529662725



Marca de tiempo Unix (UTC) de la máquina cliente.


La diferencia de tiempo máxima permitida


entre el cliente y el servidor es de 30


minutos.


  • En caso de éxito, la API devuelve los datos solicitados (véanse las consultas más abajo) y un código de estado HTTP 200.
  • Si se produce un error, el código de estado HTTP será entre 4xx y 5xx dependiendo del error y el objeto de respuesta contendrá un array con la clave «errors», que contiene una lista de mensajes de error legibles por humanos.
  • Si no hay datos coincidentes para un dispositivo, se devolverá una matriz vacía.
  • Si un Id de dispositivo no existe, sus datos de retorno serán nulos.
This site is registered on wpml.org as a development site. Switch to a production site key to remove this banner.