API Pubblica


Utilizzo API

Per utilizzare queste API è necessaria una chiave unica e personale ottenibile gratuitamente scrivendo alla mail indicata in fondo ad ogni pagina.

Documentazione

Ottenuta la chiave, per utilizzare l'API è sufficiente eseguire richieste di tipo GET all'enpoint www.poliquiz.it/api. È assolutamente necessario usare il protocollo HTTPS. L'output sarà application/json e codificato come UTF-8. Ad ogni richiesta deve essere necessariamente inviato il parametro key, ovvero la chiave richiesta in precedenza.

Elenco dei corsi

Come prima cosa, per poter richiedere le domande, è necessario conoscere la lista dei corsi e il loro relativo ID. Per farlo è sufficiente usare il parametro get_courses come nell'esempio seguente:

Esempio


Richiesta:

/api?get_courses&key=XXX

Risultato:

[
  {
    "id": 1,
    "corso": "Analisi 1"
  },
  {
    "id": 2,
    "corso": "Chimica"
  }
] 

Descrizione:

Campo Tipo Descrizione
id int L'ID del corso
corso string Il nome del corso
Elenco delle domande

Per ottenere l'elenco delle domande è necessario conoscere l'ID del corso per il quale si vogliono richiedere. I parametri da inviare sono get_questions senza valore e course_id con specificato l'ID del corso. Ecco un esempio:

Esempio


Richiesta:

/api?get_questions&course_id=2&key=XXX

Risultato:

[
  {
    "id": 1234,
    "giusta": 0,
    "verificata": false,
    "commento": null,
    "domanda": "Domanda di prova",
    "risposte": [
      {
        "risposta": "La prima risposta",
        "n": 1
      },
      {
        "risposta": "La seconda risposta",
        "n": 2
      },
      {
        "risposta": "La terza risposta",
        "n": 3
      },
      {
        "risposta": "La quarta risposta",
        "n": 4
      },
      {
        "risposta": "La quinta risposta",
        "n": 5
      }
    ]
  },
  {
    "id": 4321,
    "giusta": 2,
    "verificata": true,
    "commento": "Spiegazione della risposta",
    "domanda": "Domanda di prova 2",
    "risposte": [
      {
        "risposta": "La prima risposta",
        "n": 1
      },
      {
        "risposta": "La seconda risposta, quella giusta",
        "n": 2
      },
      {
        "risposta": "La terza risposta",
        "n": 3
      }
    ]
  }
] 

Descrizione:

Campo Tipo Descrizione
id int L'ID della domanda
giusta int L'indice della risposta corretta. Se 0 nessuna risposta giust√† è stata selezionata
verificata bool La domanda è stata verificata
commento string Il commento / perché della risposta giusta. Se null non esiste
domanda string La domanda
risposte array Array delle risposte
risposta string Una risposta
n int L'indice di quella risposta. Non coincide sempre con la sua posizione nell'array. Il parametro giusta fa riferimento a questo valore