API

---

In questa sezione presenteremo in generale gli standard dell'API per proseguire nel dettaglio di tutti gli endpoint. La documentazione si riferisce alla versione uno (v1) dell' API. Sara' comunicato e aggiornata in caso di nuove versioni.

Per poter iniziare a utilizzare le API bisogna possedere un account.

info

Se non possiedi ancora un account, registrarti qui

API Server URL

API Server e' la base di tutti gli endpoint delle API d'ItaliaKIT. Per esempio url sottostante si riferisce all'API Server, attuale, della versione 1.

https://app.italiakit.it/api/v1

Ogni qualvolta ci saranno nuovi features tecniche cambiera' la versione dell'API Server.

Parametri

I parametri sono indicati all'interno dell' endpoint fra parentesi graffe, per esempio :

https://spp.italiakit.it/api/v1/regioni/{nome_regione}

in cui {nome_regione} rappresenta il parametro che indica il nome della regione ricercato.

Media Types

Media Type di risposta da parte del Server e' di tipo JSON.

Risposta

La risposta puo' essere di due tipologie Successo oppure Errore.

Successo

{
    "data": {schema}
}

In caso di Successo il campo data conterra' lo schema (oggetto) richiesto.

info

Per i dettagli e descrizione di ogni campo dello Schema

Errore

{
    "error": {
        "code": http-status-code,
        "message": messaggio
    }
}

Invece in caso di Errore verra' riportato il codice di errore con messaggio dettagliato dell'errore.

info

I codici d' errore rispettano gli standard HTTP Status Codes

Schema (Modello)

---

In questa sezione rappresentiamo il modello di ritorno dopo una risposta di successo. Il modello sottostante rappresenta la struttura generale di una Regione in cui comprende le Province e Comuni

[
  {
    "name": "String",
    "wiki": "String",
    "cod_reg_istat": "Int",
    "repartition": "Int",
    "province": [
      {
        "id": "String",
        "name": "String",
        "info": {
          "population": "Int",
          "area_km": "Double",
          "density": "Double",
          "wiki": "String"
        },
        "comuni": [
          {
            "id": "Int",
            "nome": "String",
            "cod": {
              "cod_ente": "String",
              "cod_istat": "String",
              "cod_catastale": "String"
            },
            "contact": {
              "email": "String",
              "pec": "String",
              "tel": "String",
              "fax": "String"
            },
            "cap": "String"
          }
        ]
      }
    ]
  }
]

Regione

I campi della Regione sono da 3-6

Nome campo	Descrizione	Tipo
name	Nome della Regione	String
wiki	Link (url) Wipedia della Region	String
cod_reg_istat	Codice Istat Regione	Int
repartition	Rappresenta la posizione geografica	Int

Provincia

I campi della Provincia sono da 7-16. Province e; una Lista contenente tutte le province che appartengono alla Regione

Nome campo	Descrizione	Tipo
id	Sigla della provincia	String
name	Nome provincia	String
info	Informazioni provincia	Object
population	Popolazione totale provincia	Int
area_kmq	Area totale in km quadrati provincia	Doble
density	Densita' popolazione x km^2	Doble
wiki	Link (url) pagin wikipedia Provincia	String

Comune

I campi del Comune sono da 17, 32. Il campo comune e' una Lista contenente tutti i Comuni appartenti alla Provincia.

Nome campo	Descrizione	Tipo
id	Codice identificativo Comune	String
name	Nome Comune	String
cod	Oggetto contente codici amministrativi	Object
cod_ente	Codice elettorale	String
cod_istat	Codice Istat	String
cod_catastale	Codice catastale	String
contact	Oggetto contenente contatti del Comune	Object
email	Contatto email Comune	String
pec	Contatto email certificata	String
tel	Contatto telefonico	String
fax	Contatto Fax	String
cap	Codice di Avviamento Postale	Int