Passa al contenuto principale

Chiavi API

Le chiavi API offrono a script e integrazioni un accesso programmatico a lunga durata all'API REST senza una sessione del browser.

Emettere una chiave​

Crea una chiave in due modi:

  • Nell'app, da Impostazioni → Chiavi API.
  • Tramite l'API, con POST /api/v1/keys e un name:
curl -X POST https://<your-host>/api/v1/keys \
  -H "Authorization: Bearer <session-token>" \
  -H "Content-Type: application/json" \
  -d '{ "name": "ci-export-bot" }'

La risposta contiene la chiave completa, che inizia con ef_live_.

warning

Il valore della chiave (ef_live_...) viene mostrato una sola volta. EntityFlow ne memorizza solo un hash — non potrà mai più essere recuperata. Copiala immediatamente e conservala in un luogo sicuro.

Usare una chiave​

Inviala come bearer token in qualsiasi richiesta REST:

curl https://<your-host>/api/v1/diagrams \
  -H "Authorization: Bearer ef_live_xxxxxxxxxxxxxxxx"

Elencare e revocare​

Puoi elencare e revocare le chiavi in qualsiasi momento, da Impostazioni → Chiavi API o tramite gli endpoint /api/v1/keys. La revoca di una chiave ha effetto immediato.

Autorizzazioni​

L'emissione e la revoca delle chiavi richiedono l'autorizzazione account:manage. Una chiave eredita le autorizzazioni con ambito tenant dell'account che la possiede.