Documentazione

API Admin

Automatizza betool dai tuoi sistemi — creazione di pipeline, cronologia delle esecuzioni, gestione delle organizzazioni.

API Admin

L'intera amministrazione di betool è accessibile tramite un'API REST autenticata. È il canale dedicato all'automazione: provisioning di organizzazioni al volo, sincronizzazione delle pipeline dal tuo repository Git, dashboard personalizzate, integrazione ITSM.

Autenticazione

Token Bearer emesso da Amministrazione → Token all'interno della tua organizzazione.

curl -H "Authorization: Bearer $BETOOL_TOKEN" \
  https://platform.betool.ai/api/admin/me

Il token è associato a una sola organizzazione e a un solo ruolo. Il ruolo determina ciò che puoi leggere e scrivere.

Paginazione e filtri

Tutti gli endpoint di elenco seguono la stessa convenzione:

  • ?limit=50 (predefinito 25, massimo 200)
  • ?offset=0
  • ?sort=-created_at (prefisso - per l'ordine decrescente)
  • Filtri ad hoc: ?status=ok&created_after=2026-05-01

La risposta include un header X-Total-Count per la paginazione senza cursore.

Endpoint principali

EndpointDescrizione
GET /api/admin/meIdentità, organizzazione corrente, ruolo
GET /api/admin/pipelinesElenca le pipeline
POST /api/admin/pipelinesCrea una pipeline
PATCH /api/admin/pipelines/{id}Aggiorna una pipeline
GET /api/admin/pipelines/{id}/executionsCronologia delle esecuzioni
GET /api/admin/billing/balanceSaldo dei crediti
POST /api/admin/billing/topupRicarica manuale
GET /api/admin/me/content-readsRegistro di audit degli accessi cross-tenant

La documentazione OpenAPI completa è disponibile su /api/admin/openapi.json una volta autenticato.

Idempotenza

Gli endpoint POST accettano un header Idempotency-Key. Se reinvii la stessa richiesta con la stessa chiave, ottieni la stessa risposta — utile per le strategie di retry lato chiamante.

Webhook in uscita

Configura betool affinché ti notifichi in caso di eventi chiave (esecuzione fallita, saldo basso, nuovo utente). Consulta Webhook in uscita.

Limitazione della frequenza

Per impostazione predefinita:

  • 1.000 richieste / minuto per token
  • 100 richieste / minuto per gli endpoint di scrittura onerosi (creazione di pipeline, importazione in batch)

Con il piano Enterprise, i limiti sono configurabili.

SDK

Non esistono SDK ufficiali (per ora). L'API è abbastanza semplice da consumare da qualsiasi linguaggio dotato di un client HTTP.

Se scrivi un SDK per la tua organizzazione, faccelo sapere — lo elencheremo.