Programmazione API HTTP/HTTPS

Il software Prime/STUDIO permette di impostare dei parametri circa le API HTTP/HTTPS disponibili in centrale per l'implementazione di molti protocolli utilizzati da dispositivi esterni e che devono interfacciarsi con il sistema Prime.

In fase di programmazione della centrale è necessario prima abilitare la gestione delle API e successivamente generare una chiave da associare ad un codice utente, assicurandoci che tale codice abbia le adeguate abilitazioni ad un comando.

A seguito sarà necessario determinare la sintassi del comando che dovrà essere inviato alla centrale.

Possono essere inviati in centrali comandi per:

  • visualizzare la versione delle API

  • effettuare un test di connessione verso la centrale

  • conoscere lo stato di ogni zona di centrale

  • conoscere lo stato delle uscite

  • conoscere lo stato delle aree

  • conoscere la lista degli scenari

  • ottenere il registro eventi di centrale

  • visualizzare lo stato del dispositivo GSM Nexus collegato in centrale

  • visualizzare i guasti di sistema

  • visualizzare l’elenco delle zone “aperte” di una data area

  • visualizzare l’elenco delle zone “aperte” di un dato scenario

  • attivare/disattivare uscite

  • escludere/includere zone (necessaria abilitazione)

  • inserire/disinserire aree (necessaria abilitazione)

  • applicare scenari di inserimento

  • cancellare memorie di allarme

Cliccando sul tasto sul menu a sinistra Configurazione PrimeLAN, si deve accedere alla scheda di programmazione sulla destra alla sezione “Parametri ed email, Gestione delle chiave per le API”.

Parametri chiave API

Parametro

Sezione software

Abilita API HTTP/HTTPS

Opzione di abilitazione della generazione ed associazione di una chiave le API HTTP/HTTPS.

Parametri ed email, Gestione delle chiave per le API”

Chiave per le API

Se abilitata la funzione, si attiva la casella dove inserire e visualizzare una chiave da utilizzare per le API.

I tasti Genera e Pulisci sono da utilizzare per la generazione automatica della chiave, o per la cancellazione di quanto riportato nella casella.

Codice

Casella con menu a tendina dove selezionare il codice utente da utilizzare per autorizzare le operazioni svolte dalle API.

Permetti solo connessioni via HTTPS

Opzione per l'autorizzazione all'utilizzo delle API esclusivamente per connessioni crittografate sicure (HTTPS).

Fare riferimento a "Parametri IP e web-server".

Non permettere il disarmo

Se attiva, l'opzione non autorizza l'utilizzo di API, se causa una perdita di sicurezza del sistema.

Funzionalità

Casella con menu a tendina dove selezionare un comando o una funzione per cui si vuole visualizzare la stringa di comando da copiare.

Mostra funzioni avanzate

Opzione permette di accedere nella casella a tutte le funzionalità possibili (altrimenti vengono mostrate solo quelle ad uso comune).

Genera URL

Tasto per la generazione automatica di un indirizzo URL associato alla funzione sopra selezionata.

Tale URL comparirà nella casella a fianco.

 

Prova URL

Tasto per la prova dell'indirizzo URL nella casella a fianco, sia questo generato automaticamente, che immesso manualmente.

A seguito si apre una finestra con l'esito del comando e della risposta da centrale.