Registro entrate e uscite API

Registro entrate e uscite API, Registro Entrate-Uscite gestisce i record dalla tua app: elenca, aggiungi, aggiorna ed elimina. Gli endpoint funzionano con una chiave API invece di una sessione browser.

Avvio rapido

Crea una chiave nella sezione API per sviluppatori del tuo account; la chiave in chiaro viene mostrata solo al momento della creazione.
Invia la richiesta a https://api.pixepi.com con l'header Authorization: Bearer <key>.
Le risposte restituiscono JSON; negli endpoint di tipo elenco puoi usare i campi page, per_page e i filtri.

Richiesta di esempio

curl -H "Authorization: Bearer $PIXEPI_KEY" "https://api.pixepi.com/api/v1/apps/gelir-gider-defteri/categories"

curl -X POST "https://api.pixepi.com/api/v1/apps/gelir-gider-defteri/categories" \
  -H "Authorization: Bearer $PIXEPI_KEY" \
  -d "kind=expense" \
  -d "name=Affitto"

Endpoint di questo strumento

Metodo	Percorso	Descrizione
`GET`	`/categories`	Elenca le categorie (categorie di sistema condivise più le tue).
`POST`	`/categories`	Aggiunge una nuova categoria.
`POST`	`/categories/{id}`	Aggiorna una categoria.
`POST`	`/categories/{id}/archive`	Archivia una categoria; richiamarla di nuovo non cambia lo stato.
`GET`	`/entries`	Elenca le voci; filtra per data, tipo, categoria e nota.
`POST`	`/entries`	Aggiunge una nuova voce.
`POST`	`/entries/{id}`	Aggiorna una voce.
`POST`	`/entries/{id}/delete`	Elimina una voce.
`GET`	`/summary`	Riepilogo suddiviso: per mese, categoria o tipo.
`GET`	`/export.csv`	Esporta le voci in CSV.

Endpoint condivisi

Metodo	Percorso	Descrizione
`GET`	`/api/v1/apps`	Catalogo API
`GET`	`/api/v1/apps/gelir-gider-defteri`	Contratto dello strumento
`GET`	`/api/v1/usage`	Riepilogo utilizzo
`GET`	`/api/v1/openapi.json`	Documento OpenAPI 3.1

Limiti

Il campo limit nelle risposte di tipo elenco include informazioni su utilizzo e limiti massimi.
Le informazioni su quota e piano sono associate al tuo account; controlla lo stato attuale con GET /api/v1/usage.

Codici di errore

Codice	Significato
`unauthorized`	Chiave API mancante o non valida.
`forbidden`	Operazione non consentita con questa chiave.
`not_found`	Strumento, job o record non trovato (404 anche per accesso tra account diversi).
`invalid_input`	Convalida dell'input fallita (campo mancante o non valido, data errata, ecc.).
`invalid_request`	Richiesta non valida.
`too_large`	Dimensione del file o del body oltre il limite.
`unsupported_media`	Tipo di file non supportato.
`not_supported`	Questo strumento non può essere eseguito su questo endpoint (app con stato).
`not_ready`	Il job non è ancora completato.
`expired`	L'output è scaduto.
`no_output`	Nessun output da scaricare per questo job.
`invalid_path`	Percorso di output non valido.
`quota_exceeded`	Quota o limite di richieste superato.
`rate_limited`	Troppe richieste in poco tempo; attendi un attimo e riprova.
`csrf`	Verifica del modulo browser non riuscita (l'API esterna usa chiavi).
`conflict`	L'operazione è in conflitto con lo stato attuale.
`unavailable`	Lo strumento è temporaneamente non disponibile.
`internal_error`	Errore imprevisto del server.

Documenti

Domande frequenti

Dove posso ottenere una chiave API?

Crea una chiave nella sezione API per sviluppatori del tuo account; la chiave viene mostrata una sola volta, al momento della creazione.

Come si invia una richiesta?

Gli endpoint rispondono su https://api.pixepi.com; ogni richiesta deve includere l'intestazione "Authorization: Bearer <key>".

Quali endpoint sono disponibili nell'API di Registro Entrate-Uscite?

La tabella in alto elenca gli endpoint dichiarati; operano tutti sui record collegati al tuo account e restituiscono 404 in caso di accesso tra account diversi.

Come si legge una risposta di errore?

Il corpo dell'errore include i campi {ok:false, error, code, request_id}; i valori di code sono consultabili nella tabella dei codici di errore.