Le myNotice REST API seguono gli standard JavaScript Object Notation ( JSON ) per la formattazione dei dati. Un vantaggio principale di JSON è che aiuta a rendere API le query facili da scrivere, leggere e analizzare da sviluppatori e computer.
E' sempre possibile richiedere i dati nei formati:

• XML
• CSV (separatore ,)
• CSV2 (separatore ;)
• PSV (separatore |)
• SSV (separatore spazio)
• TSV (separatore TAB)

Informazioni su requisiti generali, autenticazione, parametri di query facoltativi, URL di richiesta e altri riferimenti.

Requisiti API e raccomandazioni

Alcune raccomandazioni da renete presenti quando si vuole lavorate con le API di myNotice:

• Parametri di richiesta: Tutti i parametri di richiesta sono obbligatori, se non diversamente specificato.
• JSON tipo di contenuto: Specificate content-type: application/json e inserite accept: application/json nel codice quando è necessario inviare dati.
• Richieste e risposte: Invia le richieste come un JSON oggetto formattato correttamente. myNotice risponde con dati JSON formattati. Le risposte del server possono contenere i dati richiesti, un codice di stato o entrambi.
• Accesso: all'interno del portale myNotice potete trovare nella bacheca i tokens che vi consentiranno di effettuare richieste API.
• Documentazione ed esempi di codice: Il testo in corsivo rappresenta una variabile fornita o passata durante la creazione o la ricezione di API dati. Sostituite il testo in corsivo con codice, parametri o altre informazioni personali.

Autenticazione

Essendo esposte delle metriche di utilizzo al momento non è necessaria l'autenticazione. Sono sufficienti i token forniti nella bacheca dell'area riservata.

Parametry query API opzionali

il parametro formato JSON/XML è opzionale. Il formato predefinito è JSON, mentre per avere i dati in formato XML va specificato.

Richieste

Per effettuare unarichiesta è sufficiente usare il metodo GET.
Esempio per ottenere la lista dei Comuni iscritti alla piattaforma:
https://mynotice.halleyveneto.it/api/v1/metrics/listclient

Di seguito i metodi che si possono utilizzare:

listclient[/xml]

Il metodo restituisce la lista dei comuni attivi in formato json/xml.
Restituisce:

• platform: nome piattaforma
• version: versione API
• currentDate: data corrente esportazione dei dati in formato timestamp
• list: lista di Comuni con bot attivi
  • name: nome Comune
  • activeAccounts: numero di operatori attivati
  • activated: data attivazione Comune in formato timestamp
  • countBots: numero di bots attivi per il Comune

listbots/tokenAAAXXX000[/xml]

Il metodo restituisce la lista dei bots attivi in formato json/xml. E' necessario passare il token del Comune
Restituisce:

• platform: nome piattaforma
• version: versione API
• currentDate: data corrente esportazione dei dati in formato timestamp
• countBots: numero di bots attivati
• listbots: lista di Comuni con bot attivi
  • bot_name: nome del bot
  • enabled: se attivo, data di attivazione in formato timestamp, altrimenti false
  • users: numero di utenti iscritti
  • messagges: numero di messaggi scambiati

botdetails/tokenAAAXXX000/botNOME_BOT[/xml]

Il metodo restituisce dettagli e statistiche del bot indicato in formato json/xml. E' necessario passare il token del Comune e lo username del bot
Restituisce:

• platform: nome piattaforma
• version: versione API
• currentDate: data corrente esportazione dei dati in formato timestamp
• bot: username del bot richiesto
• bot_name: nome del bot
• bot_auto_authorization: se il bot accetta automaticamente nuovi utenti [1] o se il bot attende l'autorizzazione degli utenti da parte di un operatore [0]
• enabled: se attivo, data di attivazione in formato timestamp, altrimenti false
• bot_description: descrizione del bot che appare appena un utente lo trova su telegram
• bot_about: informazioni che appaiono entrando nei dettagli del bot su Telegram
• bot_pic: url immagine associata al bot
• bot_commands: elenco dei comandi associati al bot
• channel_news: canale associato al bot
• last_news: ultima notizia pubblicata dal bot
• warning_email: indirizzo email a cui vengono inviate le segnalazioni fatte tramite il bot

warning[/tokenAAAXXX000][/xml]

Il metodo restituisce le statistiche delle segnalazioni su tutti i bot di tutti i Comuni. Se è specificato il token del comune fornirà solo le segnalazioni in tutti i bots del Comune.Restituisce:

• platform: nome piattaforma
• version: versione API
• currentDate: data corrente esportazione dei dati in formato timestamp
• warning: lista dei tipi di segnalazioni
  • text: tipo segnalazione
  • request: numero di ricorrenze
• totalWarning: totale segnalazioni

words[/tokenAAAXXX000[/botNOME_BOT]][/xml]

Il metodo restituisce le statistiche dell 50 parole/frasi più utilizzate su tutti i bot di tutti i Comuni. Se è specificato il token del comune fornirà solo le 50 parole più utilizzate in tutti i bots del Comune.Se è specificato anche il nome del bot, oltre al token del Comune, fornirà solo le 50 parole più utilizzate su quello specifico bot.
Restituisce:

• platform: nome piattaforma
• version: versione API
• currentDate: data corrente esportazione dei dati in formato timestamp
• bot: nome del bot; solo se richiesto uno specifico bot
• words: lista di Comuni con bot attivi
  • text: parola richiesta
  • request: numero di ricorrenze

year[/tokenAAAXXX000][/xml]

Il metodo restituisce le statistiche delle iscrizioni annuali su tutti i bot di tutti i Comuni. Se è specificato il token del comune fornirà solo le iscrizioni annuali in tutti i bots del Comune.Restituisce:

• platform: nome piattaforma
• version: versione API
• currentDate: data corrente esportazione dei dati in formato timestamp
• years: lista degli anni
  • year: l'anno
  • subscription: numero di iscrizioni al/ai bot/s
• totalSubscription: totale iscrizioni

response[/tokenAAAXXX000][/xml]

Il metodo restituisce le statistiche delle possibili risposte univoche e delle combinazioni che permettono di accedere ai contenuti.Restituisce:

• platform: nome piattaforma
• version: versione API
• currentDate: data corrente esportazione dei dati in formato timestamp
• responseCombination: lista dei valori
  • response: numero di risposte salvate
  • combination: numero di combinazioni che permettono di accedere alle risposte salvate

Esempi usi API:

• /api/v1/metrics = Rimanda alla presente guida
• /api/v1/metrics/listclient = Lista comuni attivi in formato json
  {"platform":"myNotice","version":"1.0","currentDate":"1730427918","format ":"json","list":[{"name":"Halley Veneto SRL","activeAccounts":10,"activated":1579167699,"countBots":7},{"name":"Comune Montegalda","activeAccounts":2,"activated":1579208848,"countBots":1},{"name":"Comune di Santa Maria di Sala","activeAccounts":2,"activated":1534876694,"countBots":1},{"name":"Comune di Noventa Vicentina","activeAccounts":1,"activated":1541784883,"countBots":1},{"name":"Comune Monteforte d'Alpone","activeAccounts":1,"activated":1574878290,"countBots":2},{"name":"Halley Demo","activeAccounts":21,"activated":1580921780,"countBots":1},{"name":"Halley Sardegna","activeAccounts":3,"activated":1599122849,"countBots":1},{"name":"Comune di Veggiano","activeAccounts":3,"activated":1607595573,"countBots":1},{"name":"Comune di Pieve di Soligo","activeAccounts":5,"activated":1614068953,"countBots":1},{"name":"Comune di Refrontolo","activeAccounts":2,"activated":1614069100,"countBots":2},{"name":"Comune di Caldogno","activeAccounts":1,"activated":1624001169,"countBots":0},{"name":"- Comune Dimostrativo","activeAccounts":9,"activated":1639387814,"countBots":1}]}
• /api/v1/metrics/listclient/xml = Lista comuni attivi in formato xml
  <?xml version="1.0"?> <data><platform>myNotice</platform><version>1.0</version><currentDate>1730427918</currentDate><format >xml</format ><list><item0><name>Halley Veneto SRL</name><activeAccounts>10</activeAccounts><activated>1579167699</activated><countBots>7</countBots></item0><item1><name>Comune Montegalda</name><activeAccounts>2</activeAccounts><activated>1579208848</activated><countBots>1</countBots></item1><item2><name>Comune di Santa Maria di Sala</name><activeAccounts>2</activeAccounts><activated>1534876694</activated><countBots>1</countBots></item2><item3><name>Comune di Noventa Vicentina</name><activeAccounts>1</activeAccounts><activated>1541784883</activated><countBots>1</countBots></item3><item4><name>Comune Monteforte d'Alpone</name><activeAccounts>1</activeAccounts><activated>1574878290</activated><countBots>2</countBots></item4><item5><name>Halley Demo</name><activeAccounts>21</activeAccounts><activated>1580921780</activated><countBots>1</countBots></item5><item6><name>Halley Sardegna</name><activeAccounts>3</activeAccounts><activated>1599122849</activated><countBots>1</countBots></item6><item7><name>Comune di Veggiano</name><activeAccounts>3</activeAccounts><activated>1607595573</activated><countBots>1</countBots></item7><item8><name>Comune di Pieve di Soligo</name><activeAccounts>5</activeAccounts><activated>1614068953</activated><countBots>1</countBots></item8><item9><name>Comune di Refrontolo</name><activeAccounts>2</activeAccounts><activated>1614069100</activated><countBots>2</countBots></item9><item10><name>Comune di Caldogno</name><activeAccounts>1</activeAccounts><activated>1624001169</activated><countBots>0</countBots></item10><item11><name>- Comune Dimostrativo</name><activeAccounts>9</activeAccounts><activated>1639387814</activated><countBots>1</countBots></item11></list></data>
• /api/v1/metrics/listbots/tokenhalleyveneto = Lista dei bots attivi nel Comune in formato json.
  {"platform":"myNotice","version":"1.0","currentDate":"1730427918","token":"tokenhalleyveneto","format ":"json","error":"Client token error"}
• /api/v1/metrics/botdetails/tokenhalleyveneto/botHalleyVenetoBot = Statistiche in dettaglio del bot in formato json.
  {"platform":"myNotice","version":"1.0","currentDate":"1730427918","token":"halleyveneto","bot":"botHalleyVenetoBot","format ":"json","error":"Bot error"}
• /api/v1/metrics/warning/tokenhalleyveneto = Statistiche delle segnalazioni ricevute dallo specifico Comune.
  {"platform":"myNotice","version":"1.0","currentDate":"1730427918","token":"tokenhalleyveneto","format ":"json","warnings":{"error":"Client token error"}}
• /api/v1/metrics/words = Statistiche dell 50 parole/frasi più utilizzate su tutti i bot di tutti i Comuni.
  {"platform":"myNotice","version":"1.0","currentDate":"1730427918","format ":"json","words":[{"text":"\/start","request":"3439"},{"text":"Menu principale","request":"1421"},{"text":"\/rifiuti","request":"1192"},{"text":"\ud83d\udcc3 Men\u00f9 principale","request":"905"},{"text":"Benvenuto nel servizio automatizzato per ricevere i promemoria dei rifiuti che vengono raccolti.\nTappa (premi sul bottone) o scrivi:\nAbilita promemoria (per attivare il servizio)\nDisabilita promemoria (per disattivare il servizio)\nOGGI si raccoglie ... (per sapere cosa si raccoglie oggi)\nDOMANI si raccoglie ... (per sapere cosa si raccoglie domani)","request":"702"},{"text":"\/manuale","request":"622"},{"text":"\/notizie","request":"614"},{"text":"Uffici","request":"513"},{"text":"\/meteo","request":"489"},{"text":"\/segnalazione","request":"465"},{"text":"Benvenuto nel servizio automatizzato per ricevere i promemoria dei rifiuti che vengono raccolti.\nTappa (premi sul bottone) o scrivi:\nAbilita promemoria: per attivare le notifiche\nDisabilita promemoria: per disattivare il servizio\nOGGI: per sapere cosa si raccoglie oggi\nDOMANI: per sapere cosa si raccoglie domani\nDOPODOMANI: per sapere cosa si raccoglie dopodomani","request":"413"},{"text":"\/wifi","request":"396"},{"text":"Vivere Noventa vicentina","request":"382"},{"text":"Benvenuto nella funzione di notifica del tempo. Puoi attivare o disattivare questo servizio per ricevere ogni mattina la notifica meteo del tuo Comune. Puoi inoltre chiedermi il tempo attuale o annullare l'attivit\u00e0.","request":"379"},{"text":"Amministrazione","request":"378"},{"text":"\ud83c\udfe2 Uffici","request":"364"},{"text":"Sindaco","request":"357"},{"text":"\/avviso","request":"301"},{"text":"La partecipazione dei cittadini all'attivit\u00e0 del Comune \u00e8 importante. Sono quindi ben gradite le segnalazioni. Sono sufficienti pochi passaggi. Gentilmente scrivi il tipo di segnalazione.\nAlcuni esempi:\nAffissioni abusive, Arredo urbano, Aree verdi, Rifiuti, Strade e Viabilit\u00e0, Illuminazione pubblica, Altro","request":"295"},{"text":"Scegli le categorie su cui vuoi rimanere informato.\nPremi Conferma per completare le tue scelte.\nIn qualunque momento digita \/notizie per cambiare le tue sottoscrizioni.","request":"266"},{"text":"\ud83c\uddee\ud83c\uddf9 Amministrazione","request":"233"},{"text":"\/notify","request":"210"},{"text":"Benvenuto nel servizio automatizzato per ricevere le notizie del Comune entro 10 minuti dalla pubblicazione.\nPremi o scrivi:\n Abilita notizie: per attivare il servizio\n Disabilita notizie: per disattivare il servizio\n Ultima notizia: per ricevere l'ultima notizia pubblicata","request":"202"},{"text":"Non inviare posizione","request":"191"},{"text":"assessori","request":"189"},{"text":"\/checkssl","request":"183"},{"text":"Ordinanze","request":"174"},{"text":"\/statistiche","request":"167"},{"text":"\ud83d\udd58 Orari","request":"158"},{"text":"Puoi attivare i servizi elencati, oppure crearne di nuovi, gestire gli utenti che sono iscritti ai servizi di notivifa, visualizzare lo status\/statistiche ei servizi e cancellarli.","request":"149"},{"text":"Stai gestendo l'avviso di emergenza che potrai inviare a tutti gli iscritti\n Scegli:\n [Crea avviso] per inserire un nuovo avviso.\n [Elimina avviso] per eliminare l'avviso attivo.\n [Invia avviso] per inviare l'avviso agli iscritti\n o [Annulla] per interrompere la gestione degli avvisi.","request":"146"},{"text":"\ud83d\udc65 Assessori","request":"143"},{"text":"Ora invia una foto in cui si veda il problema che vuoi segnalare, oppure invia un messaggio vuoto o 'Non invio nessuna foto' per continuare.","request":"134"},{"text":"\/dataupload","request":"125"},{"text":"\/timepassword","request":"125"},{"text":"Benvenuto. Puoi accettare\/rifiutare la notifica premendo il seguente bottone, oppure annullare l'operazione.","request":"116"},{"text":"Uffici Area Tecnica","request":"113"},{"text":"wifi","request":"110"},{"text":"\/notifica","request":"108"},{"text":"Anagrafe","request":"105"},{"text":"\/prenotazione","request":"105"},{"text":"rifiuti","request":"102"},{"text":"\/privacy","request":"98"},{"text":"Uffici Area Finanziaria","request":"96"},{"text":"\u2709\ufe0f\u260e\ufe0f Contatti","request":"96"},{"text":"\ud83d\udc64 Sindaco","request":"94"},{"text":"\ud83d\udc68\u200d\ud83d\udc69\u200d\ud83d\udc67\u200d\ud83d\udc66 Area amministrativa","request":"87"},{"text":"Non invio il mio numero","request":"82"},{"text":"Uffici e Orari","request":"81"},{"text":"Uffici Area Socio Demografica","request":"79"}]}
• /api/v1/metrics/words/tokenhalleyveneto = Statistiche delle 50 parole più utilizzate su tutti i bot di uno specifico Comune.
  {"platform":"myNotice","version":"1.0","currentDate":"1730427919","token":"halleyveneto","format ":"json","words":[{"text":"\/start","request":"951"},{"text":"\/wifi","request":"296"},{"text":"\/notify","request":"207"},{"text":"\/checkssl","request":"180"},{"text":"\/manuale","request":"164"},{"text":"Men\u00f9 principale","request":"159"},{"text":"Puoi attivare i servizi elencati, oppure crearne di nuovi, gestire gli utenti che sono iscritti ai servizi di notivifa, visualizzare lo status\/statistiche ei servizi e cancellarli.","request":"145"},{"text":"Benvenuto. Puoi accettare\/rifiutare la notifica premendo il seguente bottone, oppure annullare l'operazione.","request":"116"},{"text":"\/timepassword","request":"109"},{"text":"\/notifica","request":"108"},{"text":"\/dataupload","request":"98"},{"text":"Stai gestendo l'avviso di emergenza che potrai inviare a tutti gli iscritti\n Scegli:\n [Crea avviso] per inserire un nuovo avviso.\n [Elimina avviso] per eliminare l'avviso attivo.\n [Invia avviso] per inviare l'avviso agli iscritti\n o [Annulla] per interrompere la gestione degli avvisi.","request":"92"},{"text":"Wifi","request":"83"},{"text":"Intendevi scrivere Marco invece di Marco?","request":"66"},{"text":"\/newswithcategory","request":"64"},{"text":"E' stata aggiunto il seguente testo alle faq in quanto non so che risposta dare. Valuta se \u00e8 opportuno aggiungere una risposta o se il messaggio pu\u00f2 essere ignorato.\n--------------------\nIntendevi scrivere Marco invece di Marco?","request":"62"},{"text":"\/alert","request":"60"},{"text":"\ud83d\udcc3 Menu principale","request":"58"},{"text":"\/monitor","request":"57"},{"text":"Per poterti elencare i wifi pi\u00f9 vicini a te dovresti gentilmente condividermi la tua posizione.","request":"56"},{"text":"\/infobandi","request":"50"},{"text":"Scegli dall'elenco i servizi di notifica che vuoi attivare. Premi pi\u00f9 volte per cambiare lo stato. I pallini indicheranno lo stato. Bianco non attivo, Blu richiesta inviata, Verde autorizzato, Arancione notifica sospesa.","request":"48"},{"text":"Non inviare posizione","request":"44"},{"text":"Benvenuto nella procedura per il caricamento di dati tramite l'invio dei file. Inviami un file CSV o XLS con l'elenco dei dati da caricare, premi Lista per vedere cosa ho gi\u00e0 caricato oppure annulla l'operazione.","request":"44"},{"text":"Scegli le categorie di cui vuoi ricevere le notizie. \nApparir\u00e0 una spunta verde (\u2705) per confermare l'attivazione.\nPremi Termina per completare le tue scelte.","request":"37"},{"text":"\/notizie","request":"37"},{"text":"\/meteo","request":"35"},{"text":"Gentilmente condividimi il tuo numero di telefono per convalidare la richiesta.","request":"34"},{"text":"\ud83c\udfe2 Uffici","request":"32"},{"text":"ApiProxy\n\npaconnesse-api_boxxapps_com Richiesta di autorizzazione\nApiproxyAdmin.\n\n- Dominio: paconnesse-api.boxxapps.com.\n\n- IP: 172.21.0.1 - 192.168.40.110.\n\nAccetti?","request":"31"},{"text":"\/warning","request":"30"},{"text":"\/privacy","request":"29"},{"text":"ApiProxy\n\nRichiesta di autorizzazione ApiproxyAdmin.\n\n- Dominio: api.comune.bovolenta.pd.it.\n\n- IP: 172.18.0.1 - 217.198.131.254.\n\nAccetti?","request":"29"},{"text":"\/mycalendar","request":"28"},{"text":"Benvenuto nella funzione di notifica del tempo. Puoi attivare o disattivare questo servizio per ricevere ogni mattina la notifica meteo del tuo Comune. Puoi inoltre chiedermi il tempo attuale o annullare l'attivit\u00e0.","request":"28"},{"text":"Scrivi il testo dell'avviso.","request":"27"},{"text":"sindaco","request":"27"},{"text":"\ud83c\uddee\ud83c\uddf9 Amministrazione","request":"22"},{"text":"Indicare il dominio da aggiungere\/riattivare o inviare un file di testo contenente un dominio per ogni riga.","request":"21"},{"text":"Ciao","request":"20"},{"text":"\/taskstatus","request":"20"},{"text":"Benvenuto nella gestione dei monitorBenvenuto nella gestione dei monitor\n\ud83d\udd34 demo_vurp\n - SpeechToText (source, filter, extractDataFrom, emailTo, telegramTo, xdeskTo, moveTo, speechService)\n\n\ud83d\udd34 vurp_alan\n - SpeechToText (source, filter, extractDataFrom, emailTo, xdeskTo, moveTo, speechService)\n\n\ud83d\udfe2 vurp_monitor\n - SpeechToText (source, filter, extractDataFrom, emailTo, telegramTo, xdeskTo, moveTo, speechService)","request":"19"},{"text":"\/manual","request":"18"},{"text":"Scegli le categorie su cui vuoi rimanere informato.\nPremi Conferma per completare le tue scelte.\nIn qualunque momento digita \/notizie per cambiare le tue sottoscrizioni.","request":"18"},{"text":"La partecipazione dei cittadini all'attivit\u00e0 del Comune \u00e8 importante. Sono quindi ben gradite le segnalazioni. Sono sufficienti pochi passaggi. Gentilmente scrivi il tipo di segnalazione.\nAlcuni esempi:\nAffissioni abusive, Arredo urbano, Aree verdi, Rifiuti, Strade e Viabilit\u00e0, Illuminazione pubblica, Altro","request":"18"},{"text":"WelcomeNewswithcategoryMessage\n(AddDefaultAliasNewswithcategory)","request":"17"},{"text":"\/","request":"16"},{"text":"WelcomeDataUploadMessage","request":"15"},{"text":"cie","request":"14"},{"text":"Ora invia una foto in cui si veda il problema che vuoi segnalare, oppure invia un messaggio vuoto o 'Non invio nessuna foto' per continuare.","request":"14"}]}
• /api/v1/metrics/words/tokenhalleyveneto/botHalleyVenetoBot = Statistiche delle 50 parole più utilizzate su uno specifico bot di uno specifico Comune.
  {"platform":"myNotice","version":"1.0","currentDate":"1730427919","token":"halleyveneto","bot":"HalleyVenetoBot","format ":"json","words":{"error":"Bot error"}}
• /api/v1/metrics/year/tokenhalleyveneto = Statistiche delle iscrizioni annuali dallo specifico Comune.
  {"platform":"myNotice","version":"1.0","currentDate":"1730427919","token":"tokenhalleyveneto","format ":"json","years":{"error":"Client token error"}}