> 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/sito-web/moduli-integrativi-della-piattaforma/utilizzare-le-api-del-sito.md).

# Utilizzare le API del sito

{% hint style="info" %}
Le API (Application Programming Interface, ovvero Interfaccia di Programmazione delle Applicazioni) sono un insieme di regole, protocolli e strumenti che consentono a diverse applicazioni software di comunicare tra loro.

Le API funzionano come un intermediario che consente alle applicazioni di scambiarsi dati e funzioni in modo semplice e sicuro.
{% endhint %}

Su richiesta dell’Ente, OpenCity Italia attiva il modulo API e la relativa [documentazione](#documentazione-api). Le API consentono di integrare il sito con applicazioni esterne e automatizzare la gestione dei dati.

Le operazioni disponibili tramite API corrispondono ai [permessi di gestione dei contenuti](/sito-web/la-piattaforma/accedere-alla-piattaforma/attribuzione-dei-permessi.md) assegnati al redattore nella sezione “Gestione accessi redazione”.

## Documentazione API

Una volta attivato il modulo, gli utenti abilitati potranno accedere alla documentazione API presente sulla piattaforma, raggiungibile dal percorso "**/openapi/doc**" del proprio sito (es. <https://www.comune.bugliano.pi.it/openapi/doc>).

All'interno della documentazione, sono elencate le classi di contenuto che possono essere gestite tramite API.

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

Cliccando su una di queste, il redattore visualizza le chiamate API disponibili per la classe di contenuto.

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


---

# 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/sito-web/moduli-integrativi-della-piattaforma/utilizzare-le-api-del-sito.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.