Chiavi API

Le chiavi API ti consentono di connettere le tue applicazioni di terze parti con il tuo back office. Ti consentono di gestire e consumare le tue risorse di back office tramite richieste API in formato JSON.

Composizione

Una chiave API è definita da un nome, una data di scadenza e un set di autorizzazioni.

Le autorizzazioni consentono di definire le azioni che possono essere eseguite da una richiesta utilizzando questa chiave API. Ad esempio, elencare gli utenti, creare un nuovo compito, modificare una riunione ecc.

Sicurezza

⚠️

È consigliabile aggiungere una data di scadenza alle chiavi API in modo da poterle rinnovare a intervalli.

Utilizzo

Per effettuare una richiesta all'API di back office, è necessario fornire la chiave API tramite un'intestazione denominata x-api-key. Di seguito è riportato un esempio di richiesta CURL che consente di recuperare tutti gli utenti in formato JSON:

curl https://demo.back-office.pro/utenti \
     -H 'x-api-key: **********' \
     -H 'Accept: application/json'

La chiave API può essere ottenuta e quindi copiata negli appunti dall'interfaccia.

È inoltre possibile decidere il formato delle chiavi nella restituzione della richiesta. Per fare ciò, è necessario inviare un'intestazione x-api-inflection che può essere impostata su camel, dash, snake o pascal. Di seguito è riportato un esempio di richiesta CURL che consente di recuperare tutti gli utenti in formato JSON camelcase:

curl https://demo.back-office.pro/utenti \
     -H 'x-api-key: **********' \
     -H 'x-api-inflection: camel' \
     -H 'Accept: application/json'