Questo documento descrive come ottenere una chiave API da utilizzare con axe DevTools Linter SaaS. Se si utilizza la versione on-premises di axe DevTools Linter, non è necessario seguire queste istruzioni perché il server on-premises non richiede l'autenticazione per l'accesso.
Contesto
L'offerta SaaS di axe DevTools Linter necessita di una chiave API per autorizzare l'utilizzo dell' linter-source Endpoint REST aggiungendo un ** Authorization** Intestazione HTTP per la tua richiesta. Ad esempio, quanto segue mostra un esempio di intestazione di autorizzazione con una chiave API di esempio:
Authorization: cc57ffb2-aa21-4cc2-a11a-0257779b9909
La chiave non è valida, ma è inclusa per consentirti di vedere come appare una chiave API.
Passaggi per ottenere una chiave API
Per ottenere una chiave API per axe DevTools Linter SaaS, è necessario disporre di una versione di prova o di una licenza attiva. Se non ne hai già uno, visita la pagina di richiesta di prova per iniziare.
Una volta ottenuto l'accesso, puoi ottenere una chiave API visitando Chiavi API. Dopo aver effettuato l'accesso, vedrai una schermata simile alla seguente:
Clicca sul pulsante AGGIUNGI NUOVA CHIAVE APIe vedrai quanto segue:
Assicurati di selezionare axe Linter sotto Prodotto, assegna un nome alla chiave in Nome progetto e fai clic su SALVA.
Infine, verrà visualizzato Gestisci chiavi API , come mostrato di seguito.
Fare clic sul pulsante indicato dalla freccia per copiare la nuova chiave API negli appunti. Nella parte superiore dello schermo verrà visualizzato un messaggio che indica che la chiave API è stata copiata correttamente, come mostrato nello screenshot qui sopra.
Prossimi passi
Ora puoi utilizzare la tua chiave API per accedere ad axe DevTools Linter SaaS.
Per una guida introduttiva all'utilizzo delle API REST fornite da axe DevTools Linter, vedere [Introduzione allo sviluppo con axe DevTools Linter].(axe-linter-getting-started)
Se desideri leggere la guida di riferimento all'interfaccia REST fornita da axe DevTools Linter, consulta [axe DevTools Linter REST API Reference].(axe-linter-rest-apis)