Introduzione all'Automazione della Gestione dei Progetti

This page is not available in the language you requested. You have been redirected to the English version of the page.

Link to this page copied to clipboard

Utilizza la tua chiave API del tuo account Axe esistente per automatizzare la gestione dei progetti e dei membri

Not for use with personal data

Se la tua organizzazione gestisce un gran numero di progetti nel Axe Developer Hub, o integra e dismette frequentemente collaboratori, puoi automatizzare questo lavoro con l'API dei Progetti invece di cliccare attraverso l'interfaccia del Axe Developer Hub.

note

Non ci sono nuove credenziali da configurare. L'automazione della gestione utilizza la stessa chiave API del tuo account Axe che già usi per il resto delle API REST del Axe Developer Hub. Questo include l'API delle Sessioni e dei Risultati e l'API dello Stato dei Commit. Se riesci già a inviare i risultati dei test al Axe Developer Hub, hai già tutto ciò di cui hai bisogno.

Cosa Puoi Automatizzare

Usando la tua chiave API, la tua automazione può:

Creare, aggiornare e cancellare progetti.
Elencare ogni progetto nella tua organizzazione (come amministratore dell'organizzazione) o ogni progetto a cui appartieni.
Elencare i membri di un progetto, aggiungere un membro con un ruolo, cambiare il ruolo di un membro e rimuovere un membro.

Consulta l'Riferimento API dei Progetti per i dettagli completi sulle richieste e risposte per ogni operazione.

Prima di Iniziare

Creazione di un progetto richiede un abbonamento attivo (licenza) per quel tipo di progetto. Chiunque crei un progetto diventa automaticamente l'amministratore del progetto.
Ruoli del progetto sono amministratore e membro. Un amministratore di progetto può aggiornare o eliminare il progetto e gestirne i membri. Un membro di progetto può accedere al progetto ma non gestirlo o gestire la sua adesione.
Amministratori dell'Organizzazione possono vedere e gestire ogni progetto dei tipi autorizzati della loro organizzazione, a prescindere dalla loro adesione al progetto. Non necessitano di una licenza personale per visualizzare, aggiornare, eliminare o gestire i membri di un progetto esistente. Creare un progetto è l'unica eccezione: richiede sempre una licenza attiva, sia che il chiamante sia un amministratore dell'organizzazione o meno.
Aggiungere un membro a un progetto non richiede che il membro possegga una licenza. L'API li registra immediatamente come membri del progetto, ma non possono accedere al progetto finché non possiedono una licenza. L'utente target deve già appartenere all'organizzazione. Non puoi aggiungere qualcuno che non è già membro dell'organizzazione.
Eliminare un progetto è definitivo. Non esiste un ripristino self-service per un progetto eliminato.

Ogni tipo di progetto accetta solo specifici valori test_language e test_platform, elencati in Valori di Configurazione del Tipo di Progetto. Scegli attentamente il tipo: il tipo di un progetto non può essere modificato una volta creato.

Ottieni la Tua Chiave API

Accedi al Portale Account Axe.
Copia una chiave API del Axe Developer Hub per progetti web o CI/CD, o una chiave API del Axe DevTools Mobile per progetti mobili. Usa il valore X-API-Key di questa chiave su ogni richiesta all'API dei Progetti.

Crea Automaticamente il Tuo Primo Progetto

curl -s -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "X-API-Key: $API_KEY" \
  -d '{
    "name": "webapp-ci",
    "selected_project_type": "axe-devtools-watcher",
    "test_language": "typescript",
    "test_platform": "Playwright"
  }' \
  "https://axe.deque.com/api-pub/v1/results/projects"

La risposta include il nuovo project_id. Salvalo: ne avrai bisogno per ogni chiamata successiva contro questo progetto, incluso l'invio dei risultati dei test.

Aggiungi Compagni di Squadra al Progetto

curl -s -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "X-API-Key: $API_KEY" \
  -d '{
    "user_email_role_pairs": [
      { "user_email": "sam@example.com", "role": "member" }
    ]
  }' \
  "https://axe.deque.com/api-pub/v1/results/projects/$PROJECT_ID/memberships"

Identifica ogni utente con il loro indirizzo email del account Axe. L'utente target deve già appartenere alla tua organizzazione. Aggiungerli non richiede che possiedano una licenza, ma non possono accedere al progetto finché non la possiedono.

Prossimi Passi

Riferimento API dei Progetti per il riferimento completo degli endpoint, inclusi il recupero, l'aggiornamento e l'eliminazione dei progetti, e la gestione dei membri su larga scala con le operazioni in batch.
Riferimento API delle Sessioni e dei Risultati per recuperare i risultati di accessibilità una volta che i tuoi progetti automatizzati li stanno producendo.