Creazione e gestione delle chiavi API

Una chiave API autorizza le richieste all'API di esportazione dei dati. È possibile creare e gestire le chiavi API in Account Administration e fornire la chiave quando si inviano richieste dalla pagina Esploratore API o dalle proprie applicazioni.

Ogni richiesta all'API di esportazione dei dati deve includere una chiave API valida nell'intestazione della richiesta x-api-key. La chiave autentica la richiesta relativa al Suo account (tenant).

Per creare chiavi API, è necessario disporre dell'accesso Amministratore a Account Administration.

Si utilizzino le procedure descritte in questa sezione per:

  • Creare una nuova chiave API.
  • Modifichi il nome, la data di scadenza o la descrizione di una chiave esistente.
  • Ruotare una chiave per sostituirne il valore segreto senza modificarne l'identità.
  • Rimozione di una chiave dal sistema.
Nota: Quando si crea o si aggiorna una chiave API, trascorre un breve lasso di tempo prima che la chiave venga registrata e sia pronta per l'uso. In genere, tale intervallo è inferiore a un minuto.
  • Per creare una nuova chiave API:
    1. Nel riquadro di sinistra di Account Administration, faccia clic su Chiavi API.
    2. Fare clic su Crea chiave API.
    3. Inserisca un nome e una descrizione per questa chiave.
    4. Per Data di scadenza, scelga una data entro 367 giorni dal momento attuale.
    5. Per Licenze, selezionare Piano di utilizzo dell'esportazione dei dati RPI per le chiavi API.
    6. Fare clic su Avanti.
      La chiave è stata generata e salvata.
    7. Clicchi su Coppia per copiare la chiave generata negli appunti. Lo conservi in un luogo sicuro.
      Importante: Il valore completo della chiave viene visualizzato solo al momento della creazione della chiave. Non potrà accedervi nuovamente. Se si perde il valore, è necessario ruotare la chiave per generarne una nuova.
    1. Clicchi su Ho salvato la mia chiave per chiudere la finestra di dialogo.
  • Per modificare una chiave API esistente:
    1. Nel riquadro di sinistra di Account Administration, faccia clic su Chiavi API.
    2. Individuate la chiave che desiderate modificare. Faccia clic con il tasto destro del mouse sulla riga relativa alla chiave e selezioni Modifica chiave API.
    3. Aggiorni il nome, la data di scadenza o la descrizione secondo necessità.
      La modifica di una chiave non comporta alcuna variazione del valore della chiave. Le applicazioni che già utilizzano la chiave continuano a funzionare senza modifiche.
    4. Fare clic su Ok.
  • Per ruotare una chiave API:
    1. Nel riquadro di sinistra di Account Administration, faccia clic su Chiavi API.
    2. Individui la chiave che desidera ruotare. Faccia clic con il tasto destro del mouse sulla riga relativa alla chiave e selezioni Ruota chiave API.
    3. Impostare il parametro Periodo di sovrapposizione in giorni sul numero di giorni per i quali si desidera che sia la chiave esistente sia la versione ruotata rimangano attive contemporaneamente.
    4. Impostare un nuovo valore di Data di scadenza per la chiave.
    5. Fare clic su Ok.
    6. Clicchi su Coppia per copiare la chiave generata negli appunti. Lo conservi in un luogo sicuro.
      Importante: Il valore completo della chiave viene visualizzato solo al momento della creazione della chiave. Non potrà accedervi nuovamente. Se si perde il valore, è necessario ruotare la chiave per generarne una nuova.
    7. Aggiorni tutte le applicazioni, gli script o le sessioni di documentazione interattiva salvate che utilizzano la chiave prima della scadenza del periodo di sovrapposizione.
  • Per la rimozione di una chiave dal sistema:
    1. Nel riquadro di sinistra di Account Administration, faccia clic su Chiavi API.
    2. Individui la chiave che desidera ruotare. Faccia clic con il tasto destro del mouse sulla riga relativa alla chiave e selezioni Elimina immediatamente.
    3. Nella finestra di dialogo, selezionare Sì, elimina la chiave.
      Questo passaggio è necessario, poiché eliminare è definitivo. Una volta eliminata la chiave, non sarà più possibile recuperarla.
    4. Fare clic su Ok.

È possibile utilizzare la chiave API nuova o aggiornata nella pagina della documentazione interattiva per testare l'API di esportazione dei dati, nonché in qualsiasi applicazione che invii richieste all'API.

Related information:

Utilizzo dell'API di esportazione dei dati
Scheda Chiavi API
Chiavi API
Argomento collegato: Utilizzo dell'API di esportazione dei dati