Sindaci in Contatto - Docs

Strumenti Utente

Strumenti Sito

Traccia:
documentazione_api

Differenze

Queste sono le differenze tra la revisione selezionata e la versione attuale della pagina.

Link a questa pagina di confronto

Entrambe le parti precedenti la revisione Revisione precedente
Prossima revisione 		Revisione precedente
documentazione_api [2020/09/22 17:08]
enterprise 		documentazione_api [2020/09/22 18:11] (versione attuale)
enterprise
Linea 1: Linea 1:
-Sindaci in Contatto +====== Sindaci in Contatto Documentazione API v0.1 ======
-Documentazione API +
-V 0.1+
  
 +**Introduzione **
  
-  
-Sommario 
-Introduzione 3 
-Ambito campagne chiamate vocali 4 
-Elenco campagne create 4 
-Parametri JSON: 4 
-Risposte: 7 
-Dettaglio campagne create 8 
-Nodo specifico: 8 
-Parametri JSON: 8 
-Risposte: 11 
-Ambito campagne SMS 12 
-Elenco campagne create 12 
-Parametri JSON: 12 
-Risposte: 15 
-Dettaglio campagne create 16 
-Nodo specifico: 16 
-Parametri JSON: 16 
-Risposte: 19 
- 
- 
- 
-  
-Introduzione 
 L’accesso all’endpoint delle API del sistema Sindaci in Contatto, permette di usufruire di diverse funzionalità, usualmente presenti sul pannello web, tramite qualsiasi dispositivo o applicativo che ne faccia richiesta usando chiamate su protocollo HTTPS. L’accesso all’endpoint delle API del sistema Sindaci in Contatto, permette di usufruire di diverse funzionalità, usualmente presenti sul pannello web, tramite qualsiasi dispositivo o applicativo che ne faccia richiesta usando chiamate su protocollo HTTPS.
  
 L’ endpoint primario è raggiungibile al seguente URL: L’ endpoint primario è raggiungibile al seguente URL:
  
-https://api.sindacincontatto.it+[[https://api.sindacincontatto.it|https://api.sindacincontatto.it]]
  
 L’architettura API segue le linee guida RESTful (Representational State Transfer) L’architettura API segue le linee guida RESTful (Representational State Transfer)
  
-Le chiamate alle API dovranno avvenire tramite cURL con trasmissione di un oggetto JSON contenente dei parametri specifici per ogni nodo. +Le chiamate alle API dovranno avvenire tramite cURL con trasmissione di un oggetto JSON contenente dei parametri specifici per ogni nodo. Tali parametri sono definiti dettagliatamente nelle rispettive sezioni.   
-Tali parametri sono definiti dettagliatamente nelle rispettive sezioni. + 
-  +===== Ambito campagne chiamate vocali =====
-Ambito campagne chiamate vocali+
  
 Funzionalità disponibili: Funzionalità disponibili:
-• Elenco campagne create 
-• Dettaglio campagne create 
  
 +  * Elenco campagne create
 +  * Dettaglio campagne create
  
-Elenco campagne create+==== Elenco campagne create ====
  
 Restituisce l’elenco degli id di campagne di chiamate automatizzate dello specifico utente che ne ha fatto richiesta. Restituisce l’elenco degli id di campagne di chiamate automatizzate dello specifico utente che ne ha fatto richiesta.
  
-End Point: https://api.sindacincontatto.it/campaign/list+End Point: [[https://api.sindacincontatto.it/campaign/list|https://api.sindacincontatto.it/campaign/list]]
  
 Parametri JSON: Parametri JSON:
-• username: il proprio username 
-• password: la propria password 
  
-esempio formattazione: +  * username: il proprio username 
-{“username”:”mia_user”,”password”:”mia_password”}+  * password: la propria password 
 + 
 +esempio formattazione: {“username”:”mia_user”,”password”:”mia_password”} 
 + 
 +**Esempio di codice CURL: ** 
 +<code> 
 + 
 +curl -X POST https://api.sindacincontatto.it/campaign/list 
 + -H "Content-Type: application/json" 
 + -d '{"username":" mia_user ","password":" mia_password"}' 
 + 
 +</code>
  
-Esempio di codice CURL: +**Esempio di codice PHP:**
-curl -X POST  https://api.sindacincontatto.it/campaign/list +
- -H "Content-Type: application/json"  +
-      -d '{"username":" mia_user ","password":" mia_password"}'+
  
-  +<code>
-Esempio di codice PHP: +
-<?php+
 $url = "https://api.sindacincontatto.it/campaign/list"; $url = "https://api.sindacincontatto.it/campaign/list";
  
Linea 91: Linea 69:
 var_dump($resp); var_dump($resp);
  
-?>+</code>
  
-  +**Esempio javascript/ajax**
-Esempio javascript/ajax+
  
 +<code>
 var url = "https://api.sindacincontatto.it/campaign/list"; var url = "https://api.sindacincontatto.it/campaign/list";
  
Linea 113: Linea 91:
 xhr.send(data); xhr.send(data);
  
-  +</code>
-Risposte:+
  
-Risposta corretta:+//  // 
 + 
 +==== Risposte: ==== 
 + 
 +=== Risposta corretta: === 
 + 
 +<code>
 { {
   "response": "OK",   "response": "OK",
Linea 132: Linea 115:
 } }
  
-Errore di autenticazione:+</code> 
 + 
 +**Errore di autenticazione:** 
 + 
 +<code>
 { {
     "result": "KO",     "result": "KO",
Linea 138: Linea 125:
 } }
  
 +</code>
  
 +//  //
  
 +==== Dettaglio campagne create ====
  
-  +//Restituisce l’elenco degli id di campagne di chiamate automatizzate dello specifico utente che ne ha fatto richiesta. End Point: [[https://api.sindacincontatto.it/campaign/detail/<id_campagna|https://api.sindacincontatto.it/campaign/detail/<id_campagna]]> Nodo specifico: <id_campagna> : id della campagna di cui si desidera ricevere le informazioni di dettaglio Parametri JSON: • username: il proprio username • password: la propria password esempio formattazione: {“username”:”mia_user”,”password”:”mia_password”} Esempio di codice CURL: curl -X POST [[https://api.sindacincontatto.it/campaign/detail/1|https://api.sindacincontatto.it/campaign/detail/1]] -H "Content-Type: application/json" -d '{"username":" mia_user ","password":" mia_password"}'   //
-Dettaglio campagne create+
  
-Restituisce l’elenco degli id di campagne di chiamate automatizzate dello specifico utente che ne ha fatto richiesta.+//Esempio di codice PHP: //
  
-End Point: https://api.sindacincontatto.it/campaign/detail/<id_campagna>+//<?php $url = "https://api.sindacincontatto.it/campaign/detail/1";
  
-Nodo specifico: +$curl = curl_init($url); curl_setopt($curl, CURLOPT_URL, $url); curl_setopt($curl, CURLOPT_POST, true);; curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
  
-<id_campagna> : id della campagna di cui si desidera ricevere le informazioni di dettaglio +$headers = array(); $headers["Content-Type"] = "application/json";
-Parametri JSON: +
-• username: il proprio username +
-• password: la propria password +
- +
-esempio formattazione: +
-{“username”:”mia_user”,”password”:”mia_password”} +
- +
-Esempio di codice CURL: +
-curl -X POST  https://api.sindacincontatto.it/campaign/detail/1 +
- -H "Content-Type: application/json"  +
-      -d '{"username":" mia_user ","password":" mia_password"}' +
- +
-  +
-Esempio di codice PHP: +
-<?php +
-$url = "https://api.sindacincontatto.it/campaign/detail/1"; +
- +
-$curl = curl_init($url); +
-curl_setopt($curl, CURLOPT_URL, $url); +
-curl_setopt($curl, CURLOPT_POST, true);; +
-curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); +
- +
-$headers = array(); +
-$headers["Content-Type"] = "application/json";+
  
 curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
Linea 182: Linea 147:
 curl_setopt($curl, CURLOPT_POSTFIELDS, $data); curl_setopt($curl, CURLOPT_POSTFIELDS, $data);
  
-//for debug only! +//for debug only! curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false); curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false); $resp = curl_exec($curl); curl_close($curl); var_dump($resp); ?>   Esempio javascript/ajax var url = "https://api.sindacincontatto.it/campaign/detail/1";
-curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false); +
-curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);+
  
-$resp = curl_exec($curl); +var xhr = new XMLHttpRequest(); xhr.open("POST", url);
-curl_close($curl); +
-var_dump($resp);+
  
-?>+xhr.setRequestHeader("Content-Type", "application/json");
  
-  +xhr.onreadystatechange = function () { 
-Esempio javascript/ajax+<code>
  
-var url = "https://api.sindacincontatto.it/campaign/detail/1";+ if (xhr.readyState === 4) { 
 +    console.log(xhr.status); 
 +    console.log(xhr.responseText); 
 + }};
  
-var xhr = new XMLHttpRequest(); +</code>
-xhr.open("POST", url); +
- +
-xhr.setRequestHeader("Content-Type", "application/json"); +
- +
-xhr.onreadystatechange = function () { +
-   if (xhr.readyState === 4) { +
-      console.log(xhr.status); +
-      console.log(xhr.responseText); +
-   }};+
  
 var data = '{"username":"mia_user","password":"mia_password"}'; var data = '{"username":"mia_user","password":"mia_password"}';
Linea 212: Linea 167:
 xhr.send(data); xhr.send(data);
  
-  +  Risposte:
-Risposte:+
  
-Risposta corretta: +Risposta corretta: { 
-{ + 
-  "result": "OK", +<code> 
-  "data": { +"result": "OK", 
-    "dettagli_campagna": { +"data": { 
-      "nome_campagna": "Campagna 1 ", +  "dettagli_campagna": { 
-      "stato_campagna": "PAUSE", +    "nome_campagna": "Campagna 1 ", 
-      "data_attivazione": "2017-05-11 21:44:45" +    "stato_campagna": "PAUSE", 
-    }, +    "data_attivazione": "2017-05-11 21:44:45" 
-    "report": { +  }, 
-      "tot_lista": 1000, +  "report": { 
-      "contattati": 1000, +    "tot_lista": 1000, 
-      "risposte": 869 +    "contattati": 1000, 
-    }+    "risposte": 869
   }   }
 } }
  
 +</code>
  
-Errore di autenticazione: 
-{ 
-    "result": "KO", 
-    "mgs": "problema di autenticazione" 
 } }
  
 +Errore di autenticazione: {
  
-  +<code> 
-Ambito campagne SMS+  "result": "KO", 
 +  "mgs": "problema di autenticazione" 
 + 
 +</code> 
 + 
 +} 
 + 
 +===== Ambito campagne SMS =====
  
 Funzionalità disponibili: Funzionalità disponibili:
-• Elenco campagne create 
-• Dettaglio campagne create 
  
 +  * Elenco campagne create
 +  * Dettaglio campagne create
  
 Elenco campagne create Elenco campagne create
Linea 252: Linea 211:
 Restituisce l’elenco degli id di campagne di SMS automatizzate dello specifico utente che ne ha fatto richiesta. Restituisce l’elenco degli id di campagne di SMS automatizzate dello specifico utente che ne ha fatto richiesta.
  
-End Point: https://api.sindacincontatto.it/sms_campaign/list+End Point: [[https://api.sindacincontatto.it/sms_campaign/list|https://api.sindacincontatto.it/sms_campaign/list]]
  
-Parametri JSON: +Parametri JSON: • username: il proprio username • password: la propria password
-• username: il proprio username +
-• password: la propria password+
  
-esempio formattazione: +esempio formattazione: {“username”:”mia_user”,”password”:”mia_password”}
-{“username”:”mia_user”,”password”:”mia_password”}+
  
-Esempio di codice CURL: +Esempio di codice CURL: curl -X POST [[https://api.sindacincontatto.it/sms_campaign/list|https://api.sindacincontatto.it/sms_campaign/list]] 
-curl -X POST  https://api.sindacincontatto.it/sms_campaign/list +<code>
- -H "Content-Type: application/json"  +
-     -d '{"username":" mia_user ","password":" mia_password"}'+
  
-  + -H "Content-Type: application/json" 
-Esempio di codice PHP: +       -d '{"username":" mia_user ","password":" mia_password"}'
-<?php +
-$url = "https://api.sindacincontatto.it/sms_campaign/list";+
  
-$curl = curl_init($url); +</code>
-curl_setopt($curl, CURLOPT_URL, $url); +
-curl_setopt($curl, CURLOPT_POST, true);; +
-curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);+
  
-$headers = array(); +  Esempio di codice PHP:
-$headers["Content-Type"] = "application/json";+
  
-curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);+<?php $url = "https://api.sindacincontatto.it/sms_campaign/list"; $curl = curl_init($url); curl_setopt($curl, CURLOPT_URL, $url); curl_setopt($curl, CURLOPT_POST, true);; curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); $headers = array(); $headers["Content-Type"] = "application/json"; curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); $data = '{"username":"mia_user","password":"mia_password"}'; curl_setopt($curl, CURLOPT_POSTFIELDS, $data); //for debug only! curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false); curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
  
-$data = '{"username":"mia_user","password":"mia_password"}'; +$resp = curl_exec($curl); curl_close($curl); var_dump($resp);
- +
-curl_setopt($curl, CURLOPT_POSTFIELDS, $data); +
- +
-//for debug only! +
-curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false); +
-curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false); +
- +
-$resp = curl_exec($curl); +
-curl_close($curl); +
-var_dump($resp);+
  
 ?> ?>
  
-  +  Esempio javascript/ajax
-Esempio javascript/ajax+
  
-var url = "https://api.sindacincontatto.it/sms_campaign/list";+var url = "https://api.sindacincontatto.it/sms_campaign/list"; var xhr = new XMLHttpRequest(); xhr.open("POST", url); xhr.setRequestHeader("Content-Type", "application/json"); xhr.onreadystatechange = function () { if (xhr.readyState === 4) { console.log(xhr.status); console.log(xhr.responseText); }}; var data = '{"username":"mia_user","password":"mia_password"}'; xhr.send(data);   Risposte: Risposta corretta: { "response": "OK", "data": [ { "id_campagna": "1", "nome_campagna": "Campagna SMS 1", "data_attivazione": "2017-06-06 11:14:33" }, { "id_campagna": "2", "nome_campagna": "Campagna SMS 2", "data_attivazione": "2017-10-04 17:12:28" }, } Errore di autenticazione: { "result": "KO", "mgs": "problema di autenticazione" }   //
  
-var xhr = new XMLHttpRequest(); +//Dettaglio campagne create //
-xhr.open("POST", url);+
  
-xhr.setRequestHeader("Content-Type", "application/json");+//Restituisce l’elenco degli id di campagne di chiamate automatizzate dello specifico utente che ne ha fatto richiesta. //
  
-xhr.onreadystatechange = function () { +//End Point: [[https://api.sindacincontatto.it/sms_campaign/detail/<id_campagna|https://api.sindacincontatto.it/sms_campaign/detail/<id_campagna]]> //
-   if (xhr.readyState === 4) { +
-      console.log(xhr.status); +
-      console.log(xhr.responseText); +
-   }};+
  
-var data = '{"username":"mia_user","password":"mia_password"}';+//Nodo specifico: <id_campagna> : id della campagna di cui si desidera ricevere le informazioni di dettaglio //
  
-xhr.send(data);+//Parametri JSON: //
  
-  +//• username: il proprio username //
-Risposte:+
  
-Risposta corretta: +//• password: la propria password //
-{ +
-  "response": "OK", +
-  "data": [ +
-    { +
-      "id_campagna": "1", +
-      "nome_campagna": "Campagna SMS 1", +
-      "data_attivazione": "2017-06-06 11:14:33" +
-    }, +
-    { +
-      "id_campagna": "2", +
-      "nome_campagna": "Campagna SMS 2", +
-      "data_attivazione": "2017-10-04 17:12:28" +
-    }, +
-}+
  
-Errore di autenticazione: +//esempio formattazione: {“username”:”mia_user”,”password”:”mia_password”} //
-{ +
-    "result": "KO", +
-    "mgs": "problema di autenticazione" +
-}+
  
 +//Esempio di codice CURL: //
  
 +//curl -X POST [[https://api.sindacincontatto.it/sms_campaign/detail/1|https://api.sindacincontatto.it/sms_campaign/detail/1]] -H "Content-Type: application/json" -d '{"username":" mia_user ","password":" mia_password"}'   //
  
 +//Esempio di codice PHP: //
  
-  +//<?php $url = "https://api.sindacincontatto.it/sms_campaign/detail/1";
-Dettaglio campagne create+
  
-Restituisce l’elenco degli id di campagne di chiamate automatizzate dello specifico utente che ne ha fatto richiesta.+$curl = curl_init($url); curl_setopt($curl, CURLOPT_URL, $url); curl_setopt($curl, CURLOPT_POST, true);; curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
  
-End Point: https://api.sindacincontatto.it/sms_campaign/detail/<id_campagna> +$headers = array(); $headers["Content-Type"] = "application/json";
- +
-Nodo specifico:  +
- +
-<id_campagna> : id della campagna di cui si desidera ricevere le informazioni di dettaglio +
-Parametri JSON: +
-• username: il proprio username +
-• password: la propria password +
- +
-esempio formattazione: +
-{“username”:”mia_user”,”password”:”mia_password”} +
- +
-Esempio di codice CURL: +
-curl -X POST  https://api.sindacincontatto.it/sms_campaign/detail/1 +
- -H "Content-Type: application/json"  +
-      -d '{"username":" mia_user ","password":" mia_password"}' +
- +
-  +
-Esempio di codice PHP: +
-<?php +
-$url = "https://api.sindacincontatto.it/sms_campaign/detail/1"; +
- +
-$curl = curl_init($url); +
-curl_setopt($curl, CURLOPT_URL, $url); +
-curl_setopt($curl, CURLOPT_POST, true);; +
-curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); +
- +
-$headers = array(); +
-$headers["Content-Type"] = "application/json";+
  
 curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
Linea 384: Linea 271:
 curl_setopt($curl, CURLOPT_POSTFIELDS, $data); curl_setopt($curl, CURLOPT_POSTFIELDS, $data);
  
-//for debug only! +//for debug only! curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false); curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false); $resp = curl_exec($curl); curl_close($curl); var_dump($resp); ?>   Esempio javascript/ajax var url = "https://api.sindacincontatto.it/sms_campaign/detail/1";
-curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false); +
-curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);+
  
-$resp = curl_exec($curl); +var xhr = new XMLHttpRequest(); xhr.open("POST", url);
-curl_close($curl); +
-var_dump($resp);+
  
-?>+xhr.setRequestHeader("Content-Type", "application/json");
  
-  +xhr.onreadystatechange = function () { 
-Esempio javascript/ajax+<code>
  
-var url = "https://api.sindacincontatto.it/sms_campaign/detail/1";+ if (xhr.readyState === 4) { 
 +    console.log(xhr.status); 
 +    console.log(xhr.responseText); 
 + }};
  
-var xhr = new XMLHttpRequest(); +</code>
-xhr.open("POST", url); +
- +
-xhr.setRequestHeader("Content-Type", "application/json"); +
- +
-xhr.onreadystatechange = function () { +
-   if (xhr.readyState === 4) { +
-      console.log(xhr.status); +
-      console.log(xhr.responseText); +
-   }};+
  
 var data = '{"username":"mia_user","password":"mia_password"}'; var data = '{"username":"mia_user","password":"mia_password"}';
Linea 414: Linea 291:
 xhr.send(data); xhr.send(data);
  
-  +  Risposte:
-Risposte:+
  
 Risposta corretta: Risposta corretta:
 +
 { {
-  "result": "OK", + 
-  "data": { +<code> 
-    "dettagli_campagna": { +"result": "OK", 
-      "nome_campagna": "Campagna SMS 1", +"data": { 
-      "stato_campagna": "ACTIVE", +  "dettagli_campagna": { 
-      "data_attivazione": "2018-10-05 07:00:00" +    "nome_campagna": "Campagna SMS 1", 
-    }, +    "stato_campagna": "ACTIVE", 
-    "report": { +    "data_attivazione": "2018-10-05 07:00:00" 
-      "sms_totali": 1000, +  }, 
-      "sms_inviati": 1000 +  "report": { 
-    }+    "sms_totali": 1000, 
 +    "sms_inviati": 1000
   }   }
 +}
 +
 +</code>
 +
 } }
  
 Errore di autenticazione: Errore di autenticazione:
 +
 { {
-    "result": "KO", + 
-    "mgs": "problema di autenticazione"+<code> 
 +  "result": "KO", 
 +  "mgs": "problema di autenticazione" 
 + 
 +</code> 
 } }
  
  
documentazione_api.1600787329.txt.gz · Ultima modifica: 2020/09/22 17:08 da enterprise

Strumenti Pagina

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki