Projecten API-referentie

De Projects API stelt je in staat om Axe Developer Hub-projecten en hun lidmaatschap programmeerbaar te beheren, met dezelfde Axe Account API-sleutel die je al gebruikt voor de rest van Axe Developer Hub's REST API's. Er is geen aparte referentie voor projectbeheer. Voor een stapsgewijze introductie, zie Aan de slag met Project Management Automatisering.

Als je alleen de ID van een project wil ontdekken vanaf de naam zodat je de Sessions en Results API kunt aanroepen, zie Projecten Lijst hieronder. Als je je project-ID al kent, kun je het vinden in Axe Developer Hub en de Sessions en Results API direct aanroepen.

Authenticatie

Alle verzoeken vereisen een API-sleutel. Voorzie deze met behulp van de X-API-Key-header:

X-API-Key: <DEQUE_API_KEY>

Vind je API-sleutel in de Axe Account Portal. Kies een Axe Developer Hub API-sleutel voor web- of CI/CD-projecten. Kies een Axe DevTools Mobile API-sleutel voor mobiele projecten.

Behandel je API-sleutel als een geheim: sla deze op in een omgevingsvariabele of de geheimestore van je CI/CD-platform in plaats van deze hard te coderen in je verzoeken.

Toegangscontrole en Rechten

• Een project aanmaken vereist een actief abonnement (licentie) voor dat type project. Degene die een project aanmaakt, 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 het niet beheren of het lidmaatschap wijzigen.
• Organisatie Admins kunnen elk project van de gelicentieerde types van hun organisatie zien en beheren, ongeacht hun eigen projectlidmaatschap. Ze hebben geen persoonlijke licentie nodig om een bestaand project te bekijken, bij te werken, te verwijderen of de leden te beheren. Een project aanmaken is de enige uitzondering: het vereist altijd een actieve licentie, of de aanroeper nu een org-admin is of niet.
• Een lid toevoegen aan een project vereist niet dat het lid een licentie heeft. De API registreert hen onmiddellijk als projectlid, maar ze kunnen geen toegang tot het project krijgen totdat ze een licentie hebben. De doelgebruiker moet al tot de organisatie behoren. Je kunt iemand die geen lid is van de organisatie niet toevoegen.
• Een project verwijderen is definitief. Er is geen zelfbediening voor het herstellen van een verwijderd project.
• In elk geval is de reactie beperkt tot het product van de API-sleutel. Een Axe Developer Hub API-sleutel retourneert en beheert alleen Axe Developer Hub (web) projecten. Een Axe DevTools Mobile API-sleutel retourneert en beheert alleen Axe DevTools Mobile projecten.

Een inactief abonnement retourneert 401 Unauthorized.

Configuratiewaarden voor Projecttypes

Elk project heeft een selected_project_type, en elk type accepteert alleen een specifieke, vaste set van test_language / test_platform waarden:

De selected_project_type van een project staat vast wanneer het project wordt aangemaakt. Om een ander type te gebruiken, maak een nieuw project aan.

Projecten Lijst

Retourneert de lijst met projecten waartoe de geauthenticeerde API-sleutel toegang heeft.

Verzoek

• Eindpunt: GET https://axe.deque.com/api-pub/v1/results/projects
• Headers (vereist):
  • X-API-Key: <DEQUE_API_KEY>
  • Accept: application/json

Queryparameters

Alle queryparameters zijn optioneel.

Antwoordinhoud

Een succesvolle respons retourneert een JSON-array van projectobjecten. Elk projectobject bevat de volgende velden:

Antwoorden kunnen extra velden bevatten die hier niet zijn vermeld, en er kunnen in de loop van de tijd nieuwe velden worden toegevoegd. Negeer elk veld dat u niet herkent en vertrouw niet op niet-gedocumenteerde velden.

Voorbeeld van Antwoordinhoud

[
  {
    "project_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "webapp-ci",
    "selected_project_type": "axe-devtools-watcher",
    "test_language": "typescript",
    "test_platform": "Playwright",
    "role": "admin",
    "user_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "enterprise_id": "3f2b8e1a-6c4d-4f7e-9a0b-1d2c3e4f5a6b",
    "is_enterprise_project": true,
    "created_at": "2026-06-01T14:23:00.000Z",
    "updated_at": "2026-06-10T16:45:00.000Z",
    "run_by": "Jane Developer",
    "last_session_created_at": "2026-06-14T09:12:00.000Z",
    "has_git_information": true,
    "git_url": "https://github.com/example/webapp",
    "latest_session": {
      "id": "0d4a85a2-9e6f-44ef-b814-fee8412abeb0",
      "created_at": "2026-06-14T09:12:00.000Z",
      "git_branch": "main"
    }
  },
  {
    "project_id": "f0e1d2c3-b4a5-6789-0123-456789abcdef",
    "name": "design-system",
    "selected_project_type": "axe-devtools-html",
    "test_language": null,
    "test_platform": null,
    "role": "admin",
    "user_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "enterprise_id": "3f2b8e1a-6c4d-4f7e-9a0b-1d2c3e4f5a6b",
    "is_enterprise_project": true,
    "created_at": "2026-05-20T08:00:00.000Z",
    "updated_at": null,
    "run_by": null,
    "last_session_created_at": null,
    "has_git_information": false,
    "git_url": null,
    "latest_session": null
  },
  {
    "project_id": "c4d5e6f7-a8b9-4c0d-9e1f-2a3b4c5d6e7f",
    "name": "ios-app-ci",
    "selected_project_type": "axe-devtools-mobile",
    "test_language": null,
    "test_platform": "XCUITest",
    "role": "admin",
    "user_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "enterprise_id": "3f2b8e1a-6c4d-4f7e-9a0b-1d2c3e4f5a6b",
    "is_enterprise_project": true,
    "created_at": "2026-06-03T10:15:00.000Z",
    "updated_at": null,
    "run_by": "Jane Developer",
    "last_session_created_at": "2026-06-15T11:05:00.000Z",
    "has_git_information": false,
    "git_url": null,
    "latest_session": {
      "id": "5b6c7d8e-9f0a-4b1c-8d2e-3f4a5b6c7d8e",
      "created_at": "2026-06-15T11:05:00.000Z",
      "git_branch": null
    }
  }
]

Om het voorbeeld kort te houden, toont elk latest_session object slechts drie van zijn velden. De API retourneert meer.

Cursor Paginering

Paginering is opt-in. Zend noch page_size, noch after, en de respons retourneert uw volledige projectenlijst in één enkele respons, zonder cursor-header.

Om door resultaten heen te bladeren, gebruikt de Projecten API dezelfde cursor-gebaseerde paginering als de Sessies eindpunt. Wanneer er meer resultaten zijn dan de huidige pagina, retourneert de respons een ondoorzichtige cursorwaarde in de x-pagination-cursor header. Geef deze waarde door als de after queryparameter in uw volgende aanvraag om de volgende pagina op te halen.

Wanneer de respons geen x-pagination-cursor header heeft, bent u op de laatste pagina.

Zoek een Project-ID op Naam

Dit voorbeeld gebruikt curl en jq om een project-ID te vinden via zijn naam:

curl -s \
  -H "Accept: application/json" \
  -H "X-API-Key: $API_KEY" \
  "https://axe.deque.com/api-pub/v1/results/projects" \
  | jq -r '.[] | select(.name == "webapp-ci") | .project_id'

Geef de geretourneerde ID door aan de Sessies eindpunt om de sessies van dat project op te sommen.

Foutreacties Lijst Projecten

Haal een Project op

Retourneert een enkel project op basis van zijn ID, in hetzelfde formaat als Projecten Lijst.

Verzoek

• Eindpunt: GET https://axe.deque.com/api-pub/v1/results/projects/{project_id}
• Headers (vereist):
  • X-API-Key: <DEQUE_API_KEY>
  • Accept: application/json

Foutreacties Haal een Project op

Maak een Project

Verzoek

• Eindpunt: POST https://axe.deque.com/api-pub/v1/results/projects
• Headers (vereist):
  • X-API-Key: <DEQUE_API_KEY>
  • Content-Type: application/json
  • Accept: application/json

Verzoeklichaam

Voorbeeld van verzoeklichaam

{
  "name": "webapp-ci",
  "selected_project_type": "axe-devtools-watcher",
  "test_language": "typescript",
  "test_platform": "Playwright"
}

Antwoordinhoud

Retourneert het aangemaakte project, in dezelfde vorm als Projecten Lijst. Degene die een project aanmaakt, wordt automatisch de projectbeheerder, dus er is geen aparte lidmaatschapsoproep nodig. Een succesvolle creatie retourneert 201 Created.

Foutreacties bij het aanmaken van een project

Werk een project bij

Verzoek

• Eindpunt: PATCH https://axe.deque.com/api-pub/v1/results/projects/{project_id}
• Headers (vereist):
  • X-API-Key: <DEQUE_API_KEY>
  • Content-Type: application/json
  • Accept: application/json

Verzoeklichaam

Voorbeeld van verzoeklichaam

{
  "name": "webapp-ci-renamed"
}

Antwoordinhoud

Retourneert het bijgewerkte project, in dezelfde vorm als Projecten Lijst. Een succesvolle update retourneert 200 OK.

Foutreacties bij het bijwerken van een project

Verwijder een project

Verzoek

• Eindpunt: DELETE https://axe.deque.com/api-pub/v1/results/projects/{project_id}
• Headers (vereist):
  • X-API-Key: <DEQUE_API_KEY>
  • Accept: application/json

Antwoordinhoud

{ "deleted": true }

Foutreacties bij het verwijderen van een project

Projectlidmaatschap

Het lidmaatschap van een project is een subresource van het project. Een projectbeheerder kan het project en het lidmaatschap beheren. Een projectlid (de member rol in de onderstaande lidmaatschapsoperaties) kan toegang tot het project krijgen maar het niet beheren. De lidmaatschapsoperaties identificeren gebruikers via hun e-mailadres. Het toevoegen van een lid vereist niet dat het lid een licentie heeft. De API registreert hen onmiddellijk, maar ze kunnen geen toegang tot het project krijgen totdat ze een licentie hebben. De doelgebruiker moet al tot uw organisatie behoren. U kunt iemand die geen lid van de organisatie is niet toevoegen.

Gebruik waar mogelijk de batch-operaties hieronder. Alle drie schrijfbewerkingen accepteren meerdere gebruikers in een enkele oproep. Dit vermindert het aantal verzoeken dat u moet doen. Als u het lidmaatschap van een grote organisatie beheert, pas dan backoff en retry toe wanneer u een 429 respons ontvangt. Zie 429 Too Many Requests voor het algemene patroon.

Lijst van projectleden

• Eindpunt: GET https://axe.deque.com/api-pub/v1/results/projects/{project_id}/memberships
• Headers (vereist): X-API-Key: <DEQUE_API_KEY>, Accept: application/json

Antwoordinhoud

{
  "members": [
    {
      "user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "role": "admin",
      "email": "jane@example.com",
      "first_name": "Jane",
      "last_name": "Doe",
      "active_license": true,
      "created_at": "2026-06-01T14:23:00.000Z"
    }
  ]
}

Voeg projectleden toe

• Eindpunt: POST https://axe.deque.com/api-pub/v1/results/projects/{project_id}/memberships
• Headers (vereist): X-API-Key: <DEQUE_API_KEY>, Content-Type: application/json, Accept: application/json

Verzoeklichaam

{
  "user_email_role_pairs": [
    { "user_email": "sam@example.com", "role": "member" },
    { "user_email": "alex@example.com", "role": "admin" }
  ]
}

user_email is het e-mailadres van de gebruiker in het Axe-account. De overeenkomst negeert hoofdletters en omringende spaties. role accepteert admin of member (contributor wordt ook geaccepteerd als synoniem voor member). Elke gebruiker kan slechts eenmaal in een verzoek voorkomen. Het toevoegen van een gebruiker die al tot het project behoort, is een no-op voor dat item: het verandert hun bestaande rol niet. Dit is een batch-bewerking. Een ongeldige invoer wijst het hele verzoek af, en de API schrijft niets. De foutmelding vermeldt elk item dat is mislukt, zodat u een batch in één keer kunt corrigeren.

Een succesvol verzoek retourneert 201 Created met { "created": true }, ongeacht of het verzoek daadwerkelijk nieuwe leden heeft toegevoegd.

Verander lidrollen

• Eindpunt: PATCH https://axe.deque.com/api-pub/v1/results/projects/{project_id}/memberships
• Headers (vereist): X-API-Key: <DEQUE_API_KEY>, Content-Type: application/json, Accept: application/json
• Verzoeklichaam: dezelfde user_email_role_pairs vorm als Voeg projectleden toe

Elk user_email moet behoren tot een huidig lid van het project. Een project moet altijd minstens één admin behouden. De API wijst een verzoek af dat het project zonder beheerder achterlaat. Een enig overgebleven lid dat de enige beheerder van het project is, kan zijn eigen rol niet wijzigen. Dit is een batchbewerking. Een ongeldige invoer wijst het hele verzoek af, en de API schrijft niets.

Een succesvol verzoek retourneert 200 OK met { "ok": true }.

Projectleden verwijderen

• Eindpunt: DELETE https://axe.deque.com/api-pub/v1/results/projects/{project_id}/memberships?user_emails={comma-separated,url-encoded,emails}
• Headers (vereist): X-API-Key: <DEQUE_API_KEY>, Accept: application/json

Geef de e-mailadressen van de te verwijderen gebruikers door als een door komma's gescheiden lijst in een enkele user_emails queryparameter, en URL-codeer de waarde. Bijvoorbeeld, een letterlijke + in een adres dat niet gecodeerd is, komt aan als een spatie en wordt afgewezen als onjuist. Er is geen aanvraaginhoud. Het verwijderen van een gebruiker die geen lid is, slaagt en verwijdert niets, dus een herhaald verzoek is geen fout. Een project moet altijd minstens één admin behouden. De API wijst een verzoek af dat de laatste beheerder van het project verwijdert. Een enig overgebleven lid dat de enige beheerder van het project is, kan zichzelf niet verwijderen.

Een succesvol verzoek retourneert 200 OK met de adressen die het heeft verwijderd en de adressen die niet overeenkwamen, zodat je een typefout kunt onderscheiden van een voltooide verwijdering:

{
  "deleted": true,
  "removed": ["sam@example.com"],
  "unmatched": ["alx@example.com"]
}

Projectlidmaatschap Foutreacties