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 su Axe Developer Hub o regolarmente aggiunge e rimuove collaboratori, puoi automatizzare questo lavoro con l'API Progetti invece di cliccare attraverso l'interfaccia di 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à utilizzi per le altre REST API di Axe Developer Hub. Questo include l'API delle Sessioni e dei Risultati e l'API dello Stato del Commit. Se puoi già inviare i risultati dei test a Axe Developer Hub, hai già tutto ciò di cui hai bisogno.

Cosa Puoi Automatizzare

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

Creare, aggiornare e cancellare progetti.
Elencare tutti i progetti della tua organizzazione (come amministratore dell'organizzazione) o tutti i progetti 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.

Vedi l'Riferimento API Progetti per i dettagli completi delle richieste e delle risposte per ogni operazione.

Prima di Iniziare

Creare un progetto richiede un abbonamento attivo (licenza) per quel tipo di progetto. Chiunque crei un progetto diventa automaticamente il suo amministratore.
Ruoli del progetto sono amministratore e membro. Un amministratore di progetto può aggiornare o eliminare il progetto e gestirne i membri. Un membro del progetto può accedere al progetto ma non gestirlo o gestirne i membri.
Amministratori dell'Organizzazione possono vedere e gestire ogni progetto dei loro tipi con licenza dell'organizzazione, indipendentemente dalla loro appartenenza al progetto. Non hanno bisogno 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 chi chiami sia un amministratore dell'organizzazione o meno.
Aggiungere un membro a un progetto non richiede che tale membro possieda 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à un membro dell'organizzazione.
Eliminare un progetto è definitivo. Non esiste un ripristino self-service per un progetto eliminato.

Ogni tipo di progetto accetta solo valori specifici di test_language e test_platform, elencati in Valori di Configurazione del Tipo di Progetto. Scegli il tipo con attenzione: il tipo di un progetto non può cambiare dopo che è stato creato.

Ottieni la Tua Chiave API

Accedi al Portale Account Axe.
Copia una chiave API di Axe Developer Hub per progetti web o CI/CD, o una chiave API di Axe DevTools Mobile per progetti mobili. Usa questo valore di intestazione X-API-Key in ogni richiesta alla API 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 successiva chiamata su questo progetto, incluso l'invio dei risultati dei test.

Aggiungi Colleghi 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 tramite l'indirizzo email del loro account Axe. L'utente target deve già appartenere alla tua organizzazione. Aggiungerli non richiede che abbiano una licenza, ma non possono accedere al progetto finché non la possiedono.

Prossimi Passi

Inizia con le API Axe Developer Hub per l'autenticazione, gestione degli errori e le altre attività che puoi automatizzare con la stessa chiave API.
Riferimento API Progetti per il riferimento completo degli endpoint, compresi il recupero, l'aggiornamento e l'eliminazione dei progetti, e la gestione della membership 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.