Regole generali

  • L’API REST è disponibile sotto l’URL di base:

/public/external/api

  • Tutte le richieste devono essere inviate tramite POST.
  • L’API REST supporta solo le richieste via HTTPS.
  • Le richieste devono contenere le seguenti intestazioni:
Modifica

Nome dell’intestazione



Valore dell’intestazione



Descrizione



Tipo di contenuto



applicazione/json



fisso



auth



123…xyz



Chiave API dalla scheda “Accesso API



firma



Firma codificata in base64



Firma del payload generato con il metodo


chiave privata dalla scheda “Accesso API


  • Il corpo della richiesta deve essere un oggetto codificato json che deve contenere i seguenti valori:
Modifica

Campo



Campo Esempio Valore



Descrizione



api



v2/dispositivo/elenco dispositivi



Nome dell’API



tempo



1529662725



Timestamp Unix (UTC) del computer client.


La differenza di tempo massima consentita


tra il client e il server è di 30


minuti.


  • In caso di successo, l’API restituisce i dati richiesti (vedi le Query di seguito) e un codice di stato HTTP 200.
  • Se si verifica un errore, il codice di stato HTTP sarà compreso tra 4xx e 5xx a seconda dell’errore e l’oggetto risposta conterrà un array con la chiave “errors”, che contiene un elenco di messaggi di errore leggibili dall’uomo.
  • Se non ci sono dati corrispondenti per un dispositivo, verrà restituito un array vuoto.
  • Se l’Id di un dispositivo non esiste, i dati restituiti saranno nulli.
This site is registered on wpml.org as a development site. Switch to a production site key to remove this banner.