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.
Le credenziali API devono essere utilizzate solo da amministratori IT esperti che comprendono chiaramente gli endpoint API disponibili e le relative funzionalità. Prima di utilizzare queste credenziali nell'ambiente LDO, consulta tutta la documentazione pertinente per assicurarti di comprendere il funzionamento degli endpoint. Un uso scorretto potrebbe avere conseguenze indesiderate sul tuo ambiente.
Il supporto per problemi relativi all'uso personalizzato delle API, agli script e alla risoluzione dei problemi relativi ai risultati generati dalle API è limitato. Il supporto LDO può assisterti nella generazione delle credenziali, nell'autenticazione e nei problemi documentati della piattaforma. Tuttavia, i clienti sono responsabili della progettazione, implementazione, test e manutenzione delle proprie integrazioni API.
È 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 di LDO, è necessario generare le credenziali API nel proprio account LDO. Segui questi passaggi:
- Vai a Organizzazione e impostazioni > Impostazioni organizzazione > Account organizzazione.
- Seleziona Credenziali API per aprire il pannello Credenziali. Se non sono presenti credenziali API, devi generarle.
- Fai clic su Genera. Vengono generati un ID client e una chiave segreta. Puoi copiarli negli appunti.
Conserva queste credenziali in un luogo sicuro e rigenerale periodicamente in base alle policy di sicurezza della tua organizzazione.
Modificare le credenziali API
- Per modificare le credenziali API esistenti, fai clic su Rigenera.
- Nella finestra Rigenera chiave segreta, fai clic su Rigenera.
- Verranno emessi un nuovo ID cliente e una nuova chiave segreta.
- L'ID client e la chiave segreta non scadono finché non ne rigeneri una nuova coppia.
- Dopo aver generato le credenziali, utilizza l'URL appropriato in base alla regione in cui si trovano i dispositivi della tua organizzazione.
- Dopo aver generato una nuova coppia di ID client e chiave segreta, la coppia precedente non sarà più valida.
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.