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 Module: 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 Module verso la quale si vuole autorizzare l'accesso.
  • Nel caso di Module 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}

Eliminazione API Key

Cliccando su sarà possibile eliminare la relativa API Key.

Utilizzo API Key

Accesso a endpoint esposti da Workflow

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 Module = 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>'

Utilizzo Avanzato API Key

Accesso a risorse REST piattaforma Alida

È possibile utilizzare un'API Key per accedere, in lettura e/o in scrittura, a risorse REST Alida quali:

• Datasource
• Dataset
• Service
• ecc.

In fase di creazione API Key occorrerà selezionare:

• Module: alida
• Role: ruolo corrispondente ai permessi che si vogliono associare alla API Key

come in figura:

^{Creazione API Key per accesso risorse REST Alida}

A quel punto sarà possibile effettuare una chiamata REST del tipo indicato di seguito. Il ruolo associato alla API Key determinerà anche il tipo di metodo HTTP invocabile (GET, PUT, POST):

curl --header 'Authorization: Apikey <api-key>' \
      --location 'https://alida.<tuo-dominio>/events/alida/api/v1/<nome-risorsa>'

Dove <nome-risorsa> può assumere valori quali, ad esempio:

• datasources
• services
• models
• ecc.