Aan de Slag met Projectmanagement Automatisering

Als je organisatie een groot aantal Axe Developer Hub-projecten beheert, of vaak bijdragers toevoegt en verwijdert, kun je dat werk automatiseren met de Projecten API in plaats van door de Axe Developer Hub-interface te klikken.

Wat Je kunt Automatiseren

Met je API-sleutel kan je automatisering:

• Projecten maken, bijwerken en verwijderen.
• Elk project in je organisatie opsommen (als een org-admin) of elk project waartoe je behoort.
• Leden van een project opsommen, een lid met een rol toevoegen, de rol van een lid wijzigen en een lid verwijderen.

Zie de Projecten API Referentie voor volledige aanvraag- en responsdetails voor elke actie.

Voordat Je Begint

• Een project maken vereist een actief abonnement (licentie) voor dat projecttype. Degene die een project creëert, wordt automatisch de projectadmin.
• Projectrollen zijn admin en lid. Een projectadmin kan het project bijwerken of verwijderen en het lidmaatschap beheren. Een projectlid kan toegang krijgen tot het project, maar kan het niet beheren of het lidmaatschap beheren.
• Organisatie Admins kunnen elk project van hun organisatie van gelicentieerde types zien en beheren, ongeacht hun eigen projectlidmaatschap. Ze hebben geen persoonlijke licentie nodig om leden van een bestaand project te bekijken, bij te werken, te verwijderen of te beheren. Een project maken is de enige uitzondering: het vereist altijd een actieve licentie, of de aanvrager nu een organisatie admin is of niet.
• Een lid aan een project toevoegen vereist niet dat dat lid een licentie heeft. De API neemt ze onmiddellijk op als een projectlid, maar ze kunnen het project niet openen totdat ze een licentie hebben. De doelgebruiker moet al lid zijn van de organisatie. Je kunt niemand toevoegen die nog geen organisatie lid is.
• Een project verwijderen is definitief. Er is geen zelfbediening herstel voor een verwijderd project.

Elk projecttype accepteert alleen specifieke test_language en test_platform waarden, zoals vermeld in Project Type Configuratiewaarden. Kies het type zorgvuldig: een projecttype kan niet veranderen nadat het is aangemaakt.

Verkrijg Je API-sleutel

1. Log in op de Axe Account Portaal.
2. 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 elke aanvraag naar de Projecten API.

Creëer Automatisch Je 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 respons bevat de nieuwe project_id. Sla deze op: je hebt deze nodig voor elke volgende oproep naar dit project, inclusief het verzenden van testresultaten.

Voeg Teamleden aan het Project Toe

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 doelgebruiker moet al lid zijn van je organisatie. Het toevoegen van hen vereist niet dat ze een licentie hebben, maar ze kunnen het project niet openen totdat ze dat wel hebben.

Volgende Stappen

• Projecten API Referentie voor de volledige eindpuntreferentie, inclusief het ophalen, bijwerken en verwijderen van projecten, en het beheren van lidmaatschap op schaal met de batch-operaties.
• Sessies en Resultaten API Referentie voor het ophalen van toegankelijkheidsresultaten zodra je geautomatiseerde projecten deze produceren.