> 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

Su richiesta dell’Ente, viene messa a disposizione la documentazione per l'utilizzo delle API.

{% 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="https://3823931934-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfYDGLbEkTaK5gywjDOEN%2Fuploads%2Fgit-blob-211e8171c2bf3af5718c0e91d76a9808d6610c45%2Fimage%20(60).png?alt=media" alt=""><figcaption></figcaption></figure>

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

<figure><img src="https://3823931934-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfYDGLbEkTaK5gywjDOEN%2Fuploads%2Fgit-blob-fdb72eb4f9f07228b93fcfd3e25e5dabb839028b%2Fimage%20(61).png?alt=media" 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.opencityitalia.it/sito-web/moduli-integrativi-della-piattaforma/utilizzare-le-api-del-sito.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.