# Riferimento API (https://docs.getbeel.com/it/api/reference)

Ogni endpoint, generato dal documento OpenAPI, con il playground.

Queste pagine sono generate dal documento OpenAPI 3.1 dell'API, quindi sono sempre allineate al codice. Il documento è scaricabile da [`/openapi.json`](https://docs.getbeel.com/openapi.json) per generare client e SDK.

Le descrizioni degli endpoint sono in inglese, come i nomi dei campi.

## Playground [#playground]

Ogni pagina ha un playground per provare la richiesta dal browser. Le richieste passano da un proxy di questo sito, che inoltra solo all'API di Getbeel e non registra i corpi.

<Callout type="warn" title="Usa una chiave di test">
  Nel campo `Authorization` scrivi `Bearer gb_test_…`. Il playground gira nel
  tuo browser: non incollarci una chiave live.
</Callout>

## Convenzioni [#convenzioni]

- URL di base: `https://www.getbeel.com/api/v1`.
- Autenticazione: [chiave API](/it/api/authentication) nell'header `Authorization`.
- Errori: [forma comune](/it/api/errors) `{ "error": { type, code, message, param } }`.
- Elenchi: [paginazione a cursore](/it/api/pagination).
- `POST` che creano o inviano: header [`Idempotency-Key`](/it/api/idempotency).
