Aan de Slag met Projectmanagement Automatisering

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

Gebruik je bestaande Axe Account API-sleutel om project- en lidmaatschapsbeheer te automatiseren

Not for use with personal data

Als uw organisatie een groot aantal Axe Developer Hub-projecten beheert of regelmatig bijdragers aan- en afmeldt, kunt u dat werk automatiseren met de Projecten API in plaats van de Axe Developer Hub-interface door te klikken.

note

Er is geen nieuwe inloggegevens in te stellen. Beheerautomatisering gebruikt dezelfde Axe Account API-sleutel die u al gebruikt voor de andere REST-API's van Axe Developer Hub. Dit omvat de Sessie- en resultaten-API en de Commitstatus-API. Als u al testresultaten naar Axe Developer Hub kunt sturen, heeft u al wat u nodig heeft.

Wat U Kunt Automatiseren

Met uw API-sleutel kan uw automatisering het volgende uitvoeren:

Projecten maken, bijwerken en verwijderen.
Elk project in uw organisatie (als org-beheerder) of elk project waartoe u behoort, opsommen.
De leden van een project opsommen, een lid met een rol toevoegen, de rol van een lid wijzigen en een lid verwijderen.

Zie de API-referentie voor projecten voor volledige details over verzoeken en antwoorden voor elke bewerking.

Voordat U Begint

Een project creëren vereist een actief abonnement (licentie) voor dat projecttype. Degene die een project creëert, wordt automatisch de projectbeheerder.
Projectrollen zijn beheerder en lid. Een projectbeheerder kan het project bijwerken of verwijderen en het lidmaatschap beheren. Een projectlid heeft toegang tot het project maar kan het of het lidmaatschap niet beheren.
Organisaties Beheerders kunnen elk project van de gelicentieerde typen van hun organisatie zien en beheren, ongeacht hun eigen projectlidmaatschap. Ze hebben geen persoonlijke licentie nodig om de leden van een bestaand project te bekijken, bij te werken, te verwijderen of te beheren. Een project creëren is de enige uitzondering: het vereist altijd een actieve licentie, of de oproeper nu een organistatibeheerder is of niet.
Een lid aan een project toevoegen vereist niet dat het lid een licentie heeft. De API registreert hen onmiddellijk als een projectlid, maar ze kunnen geen toegang krijgen tot het project totdat ze een licentie hebben. De doeldggebruikers moeten al tot de organisatie behoren. U kunt iemand die nog geen organisatieleden is, niet toevoegen.
Het verwijderen van een project is definitief. Er is geen zelfbedieningsherstel voor een verwijderd project.

Elk projecttype accepteert alleen specifieke test_language en test_platform-waarden, vermeld in Projecttypeconfiguratiewaarden. Kies het type zorgvuldig: het type van een project kan niet meer veranderen nadat het is aangemaakt.

Verkrijg Uw API-sleutel

Log in op de Axe Account Portaal.
Kopieer een Axe Developer Hub API-sleutel voor web- of CI/CD-projecten, of een Axe DevTools Mobile API-sleutel voor mobiele projecten. Gebruik de X-API-Key-headerwaarde van deze sleutel bij elk verzoek aan de Projecten API.

Creëer Automatisch Uw Eerste Project

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"

De reactie bevat de nieuwe project_id. Bewaar deze: u heeft deze nodig voor elke volgende oproep tegen dit project, inclusief het verzenden van testresultaten.

Voeg Teamleden Toe aan het Project

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"

Identificeer elke gebruiker met hun Axe Account-e-mailadres. De doeldggebruiker moet al tot uw organisatie behoren. Ze toevoegen vereist niet dat ze een licentie hebben, maar ze kunnen geen toegang krijgen tot het project totdat ze dat wel doen.

Volgende Stappen

Aan de slag met de Axe Developer Hub API's voor authenticatie, foutafhandeling en de andere taken die u kunt automatiseren met dezelfde API-sleutel.
API-referentie voor projecten voor de volledige eindpuntreferentie, inclusief het ophalen, bijwerken en verwijderen van projecten, en het grootschalig beheren van lidmaatschap met de batchbewerkingen.
Referentie voor sessie- en resultaten-API voor het ophalen van toegankelijkheidsresultaten zodra uw geautomatiseerde projecten deze produceren.