Sindaci in Contatto - Docs

Strumenti Utente

Strumenti Sito

Traccia: • playground
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:27]
enterprise 		documentazione_api [2020/09/22 18:11] (versione attuale)
enterprise
Linea 1: Linea 1:
-====== Sindaci in Contatto Documentazione API V 0.1 ====== +====== Sindaci in Contatto Documentazione API v0.1 ======
- +
-======   ======+
  
 **Introduzione ** **Introduzione **
Linea 22: Linea 20:
   * Dettaglio 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.
Linea 35: Linea 33:
 esempio formattazione: {“username”:”mia_user”,”password”:”mia_password”} esempio formattazione: {“username”:”mia_user”,”password”:”mia_password”}
  
-Esempio di codice CURL: curl -X POST [[https://api.sindacincontatto.it/campaign/list|https://api.sindacincontatto.it/campaign/list]]+**Esempio di codice CURL: **
 <code> <code>
  
 +curl -X POST https://api.sindacincontatto.it/campaign/list
  -H "Content-Type: application/json"  -H "Content-Type: application/json"
-       -d '{"username":" mia_user ","password":" mia_password"}'+ -d '{"username":" mia_user ","password":" mia_password"}'
  
 </code> </code>
  
-  Esempio di codice PHP: <?php $url = "https://api.sindacincontatto.it/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);+**Esempio di codice PHP:**
  
-$resp = curl_exec($curl); curl_close($curl); var_dump($resp);+<code> 
 +$url = "https://api.sindacincontatto.it/campaign/list";
  
-?>+$curl = curl_init($url); 
 +curl_setopt($curl, CURLOPT_URL, $url); 
 +curl_setopt($curl, CURLOPT_POST, true);; 
 +curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
  
-  Esempio javascript/ajax+$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); 
 + 
 +$resp = curl_exec($curl); 
 +curl_close($curl); 
 +var_dump($resp); 
 + 
 +</code> 
 + 
 +**Esempio javascript/ajax** 
 + 
 +<code> 
 +var url = "https://api.sindacincontatto.it/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); 
 + 
 +</code> 
 + 
 +//  // 
 + 
 +==== Risposte: ==== 
 + 
 +=== Risposta corretta: === 
 + 
 +<code> 
 +{ 
 +  "response": "OK", 
 +  "data": [ 
 +    { 
 +      "id_campagna": "1", 
 +      "nome_campagna": "Campagna1", 
 +      "data_attivazione": "2017-06-06 11:14:33" 
 +    }, 
 +    { 
 +      "id_campagna": "2", 
 +      "nome_campagna": "Campagna2", 
 +      "data_attivazione": "2017-10-04 17:12:28" 
 +    }, 
 +} 
 + 
 +</code> 
 + 
 +**Errore di autenticazione:** 
 + 
 +<code> 
 +{ 
 +    "result": "KO", 
 +    "mgs": "problema di autenticazione" 
 +} 
 + 
 +</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"}'   // 
 + 
 +//Esempio di codice PHP: //
  
-var url = "https://api.sindacincontatto.it/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": "Campagna1", "data_attivazione": "2017-06-06 11:14:33" }, { "id_campagna": "2", "nome_campagna": "Campagna2", "data_attivazione": "2017-10-04 17:12:28" }, } Errore di autenticazione: { "result": "KO", "mgs": "problema di autenticazione" }   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"}'   Esempio di codice PHP: <?php $url = "https://api.sindacincontatto.it/campaign/detail/1";+//<?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); $curl = curl_init($url); curl_setopt($curl, CURLOPT_URL, $url); curl_setopt($curl, CURLOPT_POST, true);; curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
Linea 116: Linea 200:
 } }
  
-  Ambito campagne SMS+===== Ambito campagne SMS =====
  
-Funzionalità disponibili: • Elenco campagne create • Dettaglio campagne create+Funzionalità disponibili: 
 + 
 +  * Elenco campagne create 
 +  * Dettaglio campagne create
  
 Elenco campagne create Elenco campagne create
Linea 138: Linea 225:
 </code> </code>
  
-  Esempio di codice PHP: <?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);+  Esempio di codice PHP: 
 + 
 +<?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);
  
 $resp = curl_exec($curl); curl_close($curl); var_dump($resp); $resp = curl_exec($curl); curl_close($curl); var_dump($resp);
Linea 146: Linea 235:
   Esempio javascript/ajax   Esempio javascript/ajax
  
-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" }   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/sms_campaign/detail/<id_campagna|https://api.sindacincontatto.it/sms_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/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";+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" }   // 
 + 
 +//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/sms_campaign/detail/<id_campagna|https://api.sindacincontatto.it/sms_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/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";
  
 $curl = curl_init($url); curl_setopt($curl, CURLOPT_URL, $url); curl_setopt($curl, CURLOPT_POST, true);; curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); $curl = curl_init($url); curl_setopt($curl, CURLOPT_URL, $url); curl_setopt($curl, CURLOPT_POST, true);; curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
Linea 180: Linea 293:
   Risposte:   Risposte:
  
-Risposta corretta: {+Risposta corretta: 
 + 
 +{
  
 <code> <code>
Linea 200: Linea 315:
 } }
  
-Errore di autenticazione: {+Errore di autenticazione: 
 + 
 +{
  
 <code> <code>
documentazione_api.1600788466.txt.gz · Ultima modifica: 2020/09/22 17:27 da enterprise

Strumenti Pagina

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki