> For the complete documentation index, see [llms.txt](https://docs.opencityitalia.it/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.opencityitalia.it/connect/le-funzioni/le-api-key.md).

# Le API Key

{% hint style="warning" %}
Le funzioni descritte in questa pagina sono disponibili solo per l'admin
{% endhint %}

## 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**.

E' possibile creare una nuova chiave da **Crea nuova API Key** o revocarne di esistenti. La revoca interrompe immediatamente qualsiasi integrazione.

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

Al momento della creazione, la chiave API viene mostrata una sola volta e non è possibile recuperarla. Ricordati di copiarla e conservarla in un luogo sicuro; se la chiave viene persa, l'unica soluzione è revocarla e crearne una nuova.
{% endhint %}

<figure><img src="/files/aaCyfQzww0gG24ZOtjRE" alt=""><figcaption></figcaption></figure>

## Documentazione API

La documentazione API è costituita dagli endpoint REST disponibili per ogni servizio attivo sulla piattaforma. La documentazione si genera automaticamente in base ai servizi e agli eventi configurati.

Le API di OC Connect sono protette da autenticazione e per utilizzarle è necessario configurare un'API key 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 messaggi ai cittadini in modo automatico, a partire dalle configurazioni già definite nella piattaforma. Per ogni messaggio viene utilizzato il template predefinito associato all'evento, ma è possibile specificarne uno diverso se necessario.

I messaggi inviati tramite API sono visibili sia attraverso le API stesse sia direttamente nell'interfaccia della piattaforma, 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 il messaggio una volta sola.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.opencityitalia.it/connect/le-funzioni/le-api-key.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.