# Attivare le API Key

## Le API Key

Le API Key permettono di abilitare le API per inviare messaggi ai cittadini in modo automatico. L'amministratore può creare nuove chiavi e revocare quelle esistenti dalla sezione **Utenti → API Key**.

Per creare una nuova chiave, può fare clic su **Crea nuova API Key** e compilare:

* **Nome**: un'etichetta identificativa (es. *Gestionale SUAP - Produzione*)
* **Descrizione**: una nota che descrive a cosa serve la chiave
* **Scadenza**: (la chiave rimane valida fino alla scadenza)
* **Servizi abilitati**: i servizi su cui la chiave può operare

<figure><img src="https://3274777267-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fhvfma71FhcUHvlRwF4rM%2Fuploads%2FCFujDEQjjTN5uytlE1wE%2Fimage.png?alt=media&#x26;token=5e23bd0f-659e-47a0-932b-d8e1f2949292" alt=""><figcaption></figcaption></figure>

Per disabilitare una chiave esistente, fare clic su **Revoca** accanto alla chiave da disattivare. La disattivazione è immediata.

{% hint style="warning" %}
**Attenzione**

Al momento della creazione, la chiave API viene mostrata una sola volta. È necessario copiarla e conservarla in un luogo sicuro: una volta chiusa la schermata, non è più possibile recuperarla. Se la chiave viene persa, l'unica soluzione è revocarla e crearne una nuova.

Revocare una API Key interrompe immediatamente qualsiasi integrazione che la utilizza. Prima di procedere, verificare che nessun sistema in produzione dipenda dalla chiave.
{% endhint %}

## Documentazione API

Questa sezione raccoglie la documentazione degli endpoint REST disponibili per ogni servizio attivo sulla piattaforma. La documentazione è generata automaticamente dalla piattaforma in base ai servizi e agli eventi configurati: ogni Ente vede solo gli endpoint di propria competenza.

Le API di OC Connect sono protette da autenticazione e per utilizzarle è necessario configurare un'API key, che deve essere generata come descritto nel paragrafo "[Le API Key](#le-api-key)".

{% hint style="info" %}
[Clicca qui](https://www.connect.opencityitalia.it/api-docs) per leggere la documentazione completa
{% endhint %}

### Cosa è possibile fare

Tramite API è possibile inviare notifiche ai cittadini in modo automatico, a partire dalle configurazioni già definite nella piattaforma. Per ogni notifica viene utilizzato il template predefinito associato all'evento, ma è possibile specificarne uno diverso se necessario.

Le notifiche inviate tramite API sono visibili sia attraverso le API stesse sia direttamente nell'[interfaccia della piattaforma](https://docs.opencityitalia.it/manuale-di-utilizzo-di-oc-connect/funzioni-dellamministratore/visualizzare-le-notifiche-inviate), dove compaiono insieme a quelle inviate manualmente.

Le API supportano un meccanismo di idempotenza: è possibile associare a ogni richiesta una chiave univoca. Se la stessa chiave viene inviata più volte, la piattaforma riconosce la duplicazione e blocca gli invii successivi, garantendo che il cittadino riceva la notifica una volta sola.
