> For the complete documentation index, see [llms.txt](https://docs.yoplanning.support/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.yoplanning.support/it/developpeur/documentation-api-yoplanning.md).
# Documentazione dell'API di Yoplanning
### Introduzione
L'API di Yoplanning è strutturata secondo il principio REST. La nostra API offre URL prevedibili e orientati alle risorse e utilizza codici di risposta HTTP per indicare errori e successi delle chiamate API. Sfruttiamo le funzionalità HTTP integrate, come l'autenticazione HTTP e i verbi HTTP, che sono comprese dai client HTTP standard. Tutti i metodi della nostra API restituiscono JSON.
### Autenticazione
Per iniziare, è necessario richiedere un token API per interrogare l'API di Yoplanning. Per farlo, contattateci. Una volta ottenuto il token, potrete iniziare a utilizzare l'API. Tutti i metodi dell'API richiedono l'autenticazione.
Utilizziamo un sistema di autenticazione standard basato su token. Per autenticarti, è sufficiente inserire il tuo token API nell'intestazione di ogni richiesta, come segue: `Authorization: Token 4804c2cb4d87a13146d4de029f407c82149f2ada`. Nota: lo spazio tra "Token" e il nome del token è importante.
Ecco un esempio completo che utilizza curl:
```
curl -H "Content-Type: application/json" https://yoplanning.pro/api/v3.1/teams/5a90332e-568f-4980-9859-88a984844a4d/clients/8d23503e-041e-4180-98d1-641183bc5ead -H 'Authorization: Token 4804c2cb4d87a13146d4de029f407c82149f2ada'
```
Se non fornisci un token o se il token non è valido, l'API risponderà con un codice HTTP 401 (Non autorizzato) e includerà un campo "details" nella risposta JSON per aiutarti a comprendere il problema.
### Autorizzazioni
Quando hai richiesto il tuo token API, ti sono state concesse autorizzazioni specifiche su un determinato insieme di team. Ciò significa che probabilmente non potrai utilizzare tutti i metodi dell'API. Se chiami l'API di Yoplanning senza le autorizzazioni necessarie, l'API risponderà con un errore HTTP 403 (Forbidden).
### Richiesta di limitazione
Per motivi di sicurezza, il numero di richieste che è possibile effettuare è limitato. I limiti applicabili sono specificati nella specifica API, sezione "Limitazione": . Oltre tali limiti, l'API risponderà con un codice HTTP 429 (Troppe richieste).
### Panoramica
#### Squadra
Il concetto di team è fondamentale in Yoplanning (uno strumento collaborativo). Quasi tutti i metodi accettano un parametro teamId nell'URL, il che significa che tutte le azioni sono correlate a un team.
#### UUID
Molti metodi richiedono un parametro "pk" nell'URL. Questo è l'identificativo univoco della risorsa che si sta tentando di recuperare, creare, aggiornare o eliminare. Yoplanning utilizza UUID (versione 4) come identificativo univoco per tutte le risorse.
#### Endpoint e verbi HTTP
Per molte risorse sono disponibili due endpoint:
* Per accedere a un'istanza specifica, l'URL di solito termina con ``.
* Per accedere al gestore dell'istanza: questi endpoint utilizzano i seguenti verbi HTTP:
* GET: ottieni un elenco di tutte le risorse (vedi Paginazione)
* POST: Crea una nuova risorsa (l'identificativo verrà generato dal server)
#### Cercapersone
Per tutti i metodi API che forniscono un lungo elenco di risorse, viene utilizzata la paginazione. Ciò significa che non tutti i risultati verranno restituiti in una singola richiesta. Sarà necessario effettuare più richieste per ottenere l'elenco completo delle risorse.
#### Filtri
Per alcuni endpoint, è possibile filtrare i risultati aggiungendo parametri di query alla richiesta.
#### Campi estensibili
Per alcuni endpoint, l'oggetto risorsa contiene risorse annidate. Per evitare di inviare ulteriori richieste, è possibile utilizzare il meccanismo di espansione dei campi: aggiungere il parametro di query `expand` all'URL per includere direttamente una risorsa annidata nella risposta. Ad esempio: `?expand=product`. È possibile richiedere più campi separandoli con virgole e campi annidati in profondità utilizzando la notazione con il punto, ad esempio `?expand=session_group.product`.
---
# 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.yoplanning.support/it/developpeur/documentation-api-yoplanning.md?ask=&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.