Documentazione API

L'endpoint REST è invocabile attraverso il seguente link:

https://suite.sogiscuola.com/{app}/{codice_meccanografico}/app/api.php

Il parametro "{app}" dovrà essere sostituito con il tipo di applicazione con cui si vuole comunicare ("registri","proto_email","siti").

Il parametro "{codice_meccanografico}" dovrà essere sostituito con il codice meccanografico dell'istituto.

Per invocare il singolo servizio dell'API è necessario inviare via POST, al link sopra indicato, il parametro "operazione" compilandolo con il nome del servizio.

 

REGISTRO ELETTRONICO (App "registri")

 

API: "login"

Servizio da utilizzare per effettuare il login.

Dati di input: username ("username"), password ("password"), access token ("accessToken").

Dati di output: id studente, access token.


API: "logout"

Servizio da utilizzare per effettuare il logout.

Dati di input: access token ("accessToken").

 

API: "unsubscribe"

Servizio da utilizzare per disattivare le notifiche.

Dati di input: id studente ("idStudente").

 

API: "subscribe"

Servizio da utilizzare per attivare le notifiche.

Dati di input: id studente ("idStudente").


API: "assenze_studente"

Servizio da utilizzare per ricevere le assenze/entrate/uscite di uno studente

Dati di input: access token ("accessToken").

Dati di output: lista presenze.


API: "materie_studente"

Servizio da utilizzare per ricevere le discipline associate allo studente

Dati di input: access token ("accessToken").

Dati di output: lista materie.


API: "voti_studente"

Servizio da utilizzare per ricevere le valutazioni dello studente

Dati di input: access token ("accessToken").

Dati di output: lista voti.


API: "circolari_studente"

Servizio da utilizzare per ricevere le circolari delle studente

Dati di input: access token ("accessToken").

Dati di output: lista circolari.


API: "lettura_circolari_studente"

Servizio da utilizzare per ricevere le circolari lette dello studente

Dati di input: access token ("accessToken").

Dati di output: lista circolari lette.


API: "comunicazioni_studente"

Servizio da utilizzare per ricevere le comunicazioni dello studente

Dati di input: access token ("accessToken").

Dati di output: lista comunicazioni.


API: "argomenti_studente"

Servizio da utilizzare per ricevere gli argomenti lezione dello studente

Dati di input: access token ("accessToken").

Dati di output: lista argomenti lezione.


API: "compiti_studente"

Servizio da utilizzare per ricevere i compiti dello studente

Dati di input: access token ("accessToken").

Dati di output: lista compiti per casa.

 

API: "orario_classe"

Servizio da utilizzare per ricevere l'orario lezioni della classe

Dati di input: access token ("accessToken").

Dati di output: orario delle lezioni.

 

API: "colloqui_studente"

Servizio da utilizzare per ricevere i giorni di colloquio dei docenti

Dati di input: access token ("accessToken").

Dati di output: lista colloqui con i docenti.


API: "ore_assenze"

Servizio da utilizzare per ricevere le ore di assenza dello studente

Dati di input: access token ("accessToken").

Dati di output: lista ore di assenza.


API: "firmaDocumento"

Servizio da utilizzare per firmare un documento tramite un codice Datamatrix

Dati di input: access token ("accessToken"), codice del documento da firmare ("tokenFirma").

 

SOGI WEB (App "siti")

API: "login"

Servizio da utilizzare per effettuare il login.

Dati di input: username ("username"), password ("password"), access token ("accessToken").

Dati di output: id utente, access token.


API: "logout"

Servizio da utilizzare per effettuare il logout.

Dati di input: access token ("accessToken").

 

API: "unsubscribe"

Servizio da utilizzare per disattivare le notifiche.

Dati di input: id utente ("idUtente").

 

API: "subscribe"

Servizio da utilizzare per attivare le notifiche.

Dati di input: id utente ("idUtente").

 

API: "sitoListaCircolari"

Servizio da utilizzare per ricevere le circolari inserite nel sito

Dati di input: access token ("accessToken").

Dati di output: lista circolari.


API: "sitoCircolare"

Servizio da utilizzare per ricevere una circolare specifica

Dati di input: access token ("accessToken").

Dati di output: circolare da visualizzare.

 

API: "sitoPagine"

Servizio da utilizzare per ricevere la lista delle pagine del sito

Dati di input: access token ("accessToken").

Dati di output: lista delle pagine del sito.

 

PROTOMAIL (App "proto_email")

 

API: "login"

Servizio da utilizzare per effettuare il login.

Dati di input: username ("username"), password ("password"), access token ("accessToken").

Dati di output: id utente, access token.


API: "logout"

Servizio da utilizzare per effettuare il logout.

Dati di input: access token ("accessToken").

 

API: "unsubscribe"

Servizio da utilizzare per disattivare le notifiche.

Dati di input: id utente ("idUtente").

 

API: "subscribe"

Servizio da utilizzare per attivare le notifiche.

Dati di input: id utente ("idUtente").

 

API: "protomailAmministrazioneTrasparente"

Servizio da utilizzare per ricevere i documenti pubblicati nell'amministrazione trasparente.

Dati di input: access token ("accessToken").

Dati di output: lista dei documenti pubblicati in amministrazione trasparente.

 

API: "protomailAlboOnline"

Servizio da utilizzare per ricevere i documenti pubblicati in albo online.

Dati di input: access token ("accessToken").

Dati di output: lista dei documenti pubblicati in albo online.

 

 

 

 

V 1.3.1 del 30/09/2019