Vai al contenuto
Guide
Guide

Guida introduttiva

Crea e gestisci chiavi API standard e guardrail con una chiave di gestione RunAPI.

La Gestione della piattaforma consente agli amministratori dell’account di creare, esaminare, aggiornare e revocare Chiavi API standard e guardrail senza dover utilizzare il dashboard per ogni modifica.

Creare una chiave di gestione

Segui la Guida all’Autenticazione per accedere, therefore apri la pagina Chiavi di gestione e crea una chiave di gestione. Conservala separatamente dalle chiavi dell’applicazione standard. Inviala come token bearer solo agli endpoint di Gestione della Piattaforma.

HTTP
Authorization: Bearer YOUR_MANAGEMENT_KEY

Una chiave API standard non può chiamare gli endpoint di gestione di chiavi o guardrail. Una chiave di gestione valida può comunque ricevere 403 Forbidden quando il suo proprietario non dispone più del ruolo account richiesto.

Elenca le Chiavi API standard

Usa GET /api/v1/keys per esaminare le chiavi visibili all’account della chiave di gestione:

SHELL
curl "https://runapi.ai/api/v1/keys" \
  -H "Authorization: Bearer YOUR_MANAGEMENT_KEY"

Usa gli identificatori pubblici restituiti per successive richieste di recupero, aggiornamento, revoca o assegnazione di guardrail. Non dedurre mai l’accesso dal nome di una chiave o da un token mascherato.

Crea e ruota una chiave

Crea una chiave applicativa con POST /api/v1/keys. Il secret completo viene restituito solo nella risposta di creazione, quindi salvalo nel tuo gestore di secret prima di scartare quella risposta. La rotazione deve creare una sostituzione, distribuirla nell’applicazione, verificare il traffico e quindi revocare la vecchia chiave.

SHELL
curl -X POST "https://runapi.ai/api/v1/keys" \
  -H "Authorization: Bearer YOUR_MANAGEMENT_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Production worker"}'

credit_limit_windows accetta qualsiasi combinazione di limiti di spesa progressivi 1h, 1d e 7d. Se una finestra temporale configurata viene esaurita, le chiamate con quella chiave restituiscono 429 Too Many Requests fino a quando l’utilizzo non esce dalla finestra temporale. Invia un oggetto vuoto quando aggiorni una chiave per eliminare tutti i limiti di spesa progressivi.

Applica guardrail

I Guardrail sono policy di account riutilizzabili per i controlli su modello, provider e spesa. Gestisci le policy tramite /api/v1/guardrails, quindi utilizza /api/v1/guardrail_assignments per associarle o rimuoverle. Considera un’assegnazione rifiutata come un errore di policy o di proprietà anziché continuare silenziosamente senza il guardrail.

Gestisci gli errori di gestione

  • 401 Unauthorized indica che la credenziale è assente, malformata, revocata o non valida.
  • 403 Forbidden indica che la classe di credenziale o il ruolo dell’account non è autorizzato a eseguire l’operazione.
  • 404 Not Found indica che la risorsa richiesta non è visibile all’account autenticato.
  • 422 Unprocessable Content indica che uno o più valori inviati violano una regola della risorsa.