API REST · schema OpenAPI

Costruisci su PrivateCore

Un'API REST e un principio: gira sulla tua istanza, mai su un server condiviso con altri clienti. Online è il server affittato per te; con il Mac mini è la macchina del tuo bancone. Le chiavi sono tue e le revochi con un clic.

Cosa permette di fare l'API

  • Collegare i tuoi strumenti: un foglio Airtable, uno Slack, un ERP storico, una dashboard Grafana fatta in casa.
  • Automatizzare il ricorrente: generare le fatture ricorrenti del mese, far partire un sollecito quando un preventivo resta non firmato per 7 giorni, sincronizzare le giacenze con un fornitore.
  • Costruire applicazioni interne: un'app mobile per la squadra di sala, un widget di prenotazione sul tuo sito vetrina, una dashboard di sede su misura per la direzione.
  • Verificare ed esportare: recuperare tutta la tua contabilità in JSON, generare il file FEC francese a richiesta, replicare il tuo database nel tuo data warehouse.

Due esempi di chiamata

TypeScript

fetch
TypeScript 
const base = 'https://votre-instance';
const headers = { Authorization: `Bearer ${process.env.PRIVATECORE_API_KEY}` };

// Elencare i clienti (chiave con ambito read:crm)
const { items, next_cursor } = await fetch(`${base}/api/public/v1/clients?limit=50`, { headers })
  .then((r) => r.json());

Python

requests
Python 
import os
import requests

base = "https://votre-instance"
headers = {"Authorization": f"Bearer {os.environ['PRIVATECORE_TOKEN']}"}

# Esportare il file FEC dell'esercizio in corso
fec = requests.get(f"{base}/api/fec/export", params={"year": 2026}, headers=headers)
open("fec_2026.txt", "wb").write(fec.content)

Autenticazione

Chiavi API con ambito limitato, revocabili, con una data di scadenza se vuoi.

  • Creazione: una chiave per integrazione, dall'area Sviluppatore della tua istanza. Scegli tu i suoi ambiti (lettura dei clienti, delle prenotazioni, ecc.).
  • Mai leggibili dopo: la chiave viene mostrata una sola volta, alla creazione. La tua istanza ne conserva solo un'impronta SHA-256. Se la perdi, la revochi e ne crei un'altra.
  • Monitoraggio: ogni chiave conserva la data dell'ultimo utilizzo, per individuare quelle che non servono più.
  • Revoca immediata: un clic e il token è invalidato all'istante.

Limiti di utilizzo

Nessuna quota fatturata. Ogni chiave è limitata a 60 richieste al minuto (regolabile sull'istanza), così uno script impazzito non rallenta l'interfaccia degli altri utenti.

Oltre, l'API risponde 429 con un'intestazione Retry-After: lo script aspetta un minuto e riprende.

Documentazione e stato

  • Documentazione completa: /docs sulla vostra istanza (riferimento OpenAPI generato dal codice).
  • Registro delle modifiche: ogni versione del backend espone un endpoint /api/v1/changelog.
  • OpenAPI: specifica OpenAPI 3.1 disponibile apertamente su /api/openapi.json. Compatibile con Postman, Insomnia e i generatori di codice di terze parti.
  • Stato: l'API espone punti di salute (/health, /health/ready) che uno strumento di sorveglianza può interrogare.
Chiedere un accesso API

Pronto a riprendere il controllo?

Un'installazione su misura, una risposta del fondatore e un Mac Mini che compri tu o che ti consegniamo configurato.

Ordinare Parlare con un fondatore