Generazione delle credenziali API
Questo articolo fornisce una guida passo-passo su come generare e gestire le credenziali API per il portale Lenovo Device Orchestration (LDO). Copre il processo di creazione del Client ID e della Secret Key, l'ottenimento di un Bearer Token per l'autenticazione e l'accesso a diversi endpoint API. Inoltre, spiega come utilizzare la documentazione Swagger per esplorare e testare i metodi API disponibili.
È necessario disporre di un account di Amministrazione dell'Organizzazione nel portale LDO per generare le credenziali API.
Generare le credenziali API
Prima di utilizzare le API LDO, è necessario generare le credenziali API nel proprio account LDO. Seguire questi passaggi:
- Fare clic su Informazioni sul dispositivo dal menu a discesa di navigazione in alto.
- Navigare su Configurazione / Impostazioni Informazioni sul dispositivo.
- Fare clic su Credenziali API per aprire il pannello delle credenziali.
- Se non ci sono credenziali API, è necessario generarle.
- Fare clic su Genera.
- Vengono generati un ID Cliente e una chiave segreta. È possibile copiarli negli appunti.
- Conservare queste credenziali in un luogo sicuro e rigenerarle periodicamente secondo le politiche di sicurezza della propria organizzazione.
- Se si desidera modificare le credenziali API esistenti, è necessario generarne di nuove.
- Fare clic su Rigenera.
- Nella finestra Rigenera segreto, fare clic su Rigenera.
- Verranno emessi un nuovo ID cliente e una nuova Chiave segreta.
- Il ID cliente e la Chiave segreta non scadono finché non si rigenera una nuova coppia.
- Dopo aver generato le credenziali, utilizzare l'URL appropriato in base alla regione in cui si trovano i dispositivi della propria organizzazione.
Dopo aver generato una nuova coppia di ID cliente e Chiave segreta, la vecchia coppia diventa invalidata.
Ottenere un Bearer Token
Il bearer token è un tipo di token di accesso che utilizza Auth 2.0 con un periodo di scadenza di 30 minuti. Per ottenere un nuovo token di accesso, la propria applicazione deve inviare questo bearer token insieme al proprio Client ID al server di autenticazione. Questo processo di verifica garantisce che solo l'applicazione autorizzata (quella per cui il bearer token è stato originariamente emesso) possa richiedere nuovi token di accesso.
- Generare il token API bearer utilizzando l'API esterna.
- L'URL: URL di base + /api/v1/auth/<nome_organizzazione>/token
- L'URL di base dipende dalla propria regione (NA o UE).
- Il corpo deve essere x-www-form-urlencoded e deve contenere:
- grant_type: client_credentials
- client_secret: secret (dalla pagina delle credenziali API)
- client_id: id (dalla pagina delle credenziali API)
Generare un nuovo bearer token quando scade dopo 30 minuti.
Esplorare le Operazioni API con Swagger
L'archivio delle specifiche Swagger contiene una cartella con un file index.html e alcuni altri file JavaScript.
- Scaricare il file zip delle Specifiche Swagger che fornisce dettagli su ogni API.
- Estrarre i file nella cartella.
- Fare doppio clic per aprire index.html. Si vedrà la pagina principale delle API LDO Device Insights (LDI è legacy) in Swagger.
- Generare un Bearer token.
Provare le API
- Selezionare un metodo API in Swagger.
- Utilizzare il bearer token nella chiamata.
- Fare clic su Try it out.