API Key

Gestione delle API Key

E' possibile accedere al pannello di gestione delle API Key attraverso il menù laterale, come indicato in figura:

^{Menù laterale con link accesso a pagina gestione API Keys evidenziata}

Visualizzazione API Key

Una volta raggiunta la pagina di gestione, sarà possibile:

• Visualizzare l'elenco di API Key che l'utente ha precedentemente generato
• Cercare tra queste
• Creare API Key
• Eliminare API Key

^{Pagina di gestione delle API Keys}

Creazione API Key

Cliccando su si aprirà il pannello di creazione API Key:

^{Pannello di creazione API Key}

Da qui, selezionare:

• Un Client: modulo ALIDA al quale si vuole accedere attraverso API Key. Tra questi:
  • bda: per la generazione di una chiave per l'accesso ad un Workflow che espone endpoint REST
• Un Role: entità gestita dal modulo selezionato in Client verso la quale si vuole autorizzare l'accesso.
  • Nel caso di client di tipo bda, sarà possibile selezionare uno tra i Workflow

Una volta cliccato su Salva, verrà mostrata la chiave generata:

Salvataggio chiave

La chiave andrà conservata con cura, in quanto non sarà più possibile ricopiarla

^{Pannello con risultato creazione API Key}

Utilizzo API Key

Supponiamo di aver creato un Workflow con un Service che espone una porta di tipo REST. Se volessimo accedere all'endpoint da questa esposta attraverso API Key, occorrerà creare una nuova API Key con Client bda e Role id-del-workflow-contenente-il-service.

A quel punto, utilizzandola in una chiamata REST come di seguito indicato, sarà possibile accedere all'endpoint:

curl --header 'Authorization: Apikey <api-key>' \
      --location 'https://alida.<tuo-dominio>/events/bda/<bda-id>/<service-id>/<path-based-on-your-app>'

Eliminazione API Key

Cliccando su sarà possibile eliminare la relativa API Key.