Applicazione Chiavi API
Utilizzare le chiavi API per abilitare un'integrazione da macchina a macchina in ingresso per un client esterno. Le chiavi API possono essere utilizzate dalle API OSLC e REST e possono anche essere utilizzate come parte del framework di integrazione Manage .
In un'integrazione da macchina a macchina, una macchina esterna interagisce con i dati Gestisci nel sistema Gestisci senza utilizzare un browser. Le chiavi API sono una forma nativa di autenticazione che non richiede un repository esterno per la memorizzazione della password.
Per impostazione predefinita, tutte le chiavi API sono codificate nell'archivio. Questa impostazione è controllata dalla proprietà mxe.secureapikey .
Aggiunta di chiavi API per API REST
Quando una chiave API viene assegnata al client esterno, il client esterno può accedere e interagire con i dati nel sistema Manage utilizzando la chiave API come un parametro di query apikey o un'intestazione di richiesta apikey nelle chiamate API REST. Le chiamate API REST che utilizzano una chiave API non creano una connessione server persistente e la chiave API deve far parte di tutte le richieste API REST effettuate dal client esterno.
Per utilizzare una chiave API, vai a dal menu.
Utilizzo delle chiavi API create esternamente
MXAPIAPIKEY e fornendo la chiave API generata utilizzando la proprietà json "apikey", come mostrato nel seguente codice:POST /oslc/os/mxapiapikey
{
"apikey":"<outside generated apikey>",
"expiration":-1
}Accesso alla sicurezza
Come amministratore di sistema, è necessario sincronizzare Gestisci utenti per i client esterni prima che vengano create le chiavi API per quei client. Le autorizzazioni associate alla chiave API sono determinate dalle autorizzazioni per l'utente associato. Puoi creare e configurare le chiavi API dall'applicazione Chiavi API in Integrazione.
Puoi inoltre specificare la sicurezza che abilita solo l'utente collegato a creare una chiave API. Per limitare la creazione di chiavi API per l'utente collegato, andare all'applicazione Proprietà del sistema e filtrare per la proprietà mxe.apikeyforloggedinuser . Nel campo Valore globale , specificare 1 e salvare il record. Selezionare Aggiornamento attivo per applicare il valore immediatamente.
Per disabilitare l'accesso al sistema Gestisci per un client esterno, è possibile eliminare la chiave API associata, ma il client esterno potrebbe ancora accedere al sistema Gestisci utilizzando un altro sistema di autenticazione configurato. Se una chiave API è compromessa, elimina la chiave e crea un'altra chiave per tale utente.