Projecten API-referentie

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

Lijst uw Axe Developer Hub-projecten en zoek een project-ID programmatisch op met behulp van de REST API

Not for use with personal data

Het Projecten-eindpunt retourneert de lijst met Axe Developer Hub-projecten waartoe uw API-sleutel toegang heeft. Gebruik het om de ID van een project te ontdekken op basis van de naam, zodat u die ID kunt doorgeven aan de Sessies en Resultaten API.

Als u uw project-ID al kent, kunt u deze vinden in Axe Developer Hub en de Sessies en Resultaten API rechtstreeks aanroepen; u heeft dit eindpunt niet nodig.

Authenticatie

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

X-API-Key: <DEQUE_API_KEY>

Vind uw API-sleutel in de Axe Accountportaal. Kies een Axe Developer Hub API-sleutel voor web- of CI/CD-projecten, of een Axe DevTools Mobile API-sleutel voor mobiele projecten.

Toegangsbeheer

Projectleden zien alleen de projecten waartoe ze behoren.
Organisatiebeheerders met een actieve Axe Developer Hub- of Axe DevTools Mobile-abonnement zien elk project in hun organisatie van dat producttype, ongeacht het projectlidmaatschap.
In beide gevallen is de respons afgestemd op het product van de API-sleutel: een Axe Developer Hub API-sleutel retourneert alleen Axe Developer Hub-projecten, en een Axe DevTools Mobile API-sleutel retourneert alleen Axe DevTools Mobile-projecten.

Een inactief abonnement retourneert 401 Unauthorized.

Projecten Eindpunt

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

Query Parameters

Alle queryparameters zijn optioneel.

Parameter	Omschrijving
`project_types`	Komma-gescheiden lijst van projecttypen om te retourneren, bijvoorbeeld `axe-devtools-watcher,axe-devtools-html`. Accepteert ook de aliassen `web` en `mobile`, die elk uitbreiden naar de concrete typen voor dat product. Wanneer weggelaten, wordt elk projecttype dat uw API-sleutel kan openen geretourneerd.
`page_size`	Aantal projecten dat per pagina moet worden geretourneerd. Standaard: `30`. Maximum: `100`. Waarden boven het maximum worden beperkt tot `100`. Zie Cursor Paginering.
`after`	Cursorwaarde van de vorige reactie, gebruikt om de volgende pagina op te halen. Zie Cursor Paginering.

Reactie Lichaam

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

Veld	Type	Omschrijving
`project_id`	String	Unieke identificatie voor het project. Gebruik deze waarde als `{project_id}` bij het aanroepen van de Sessies eindpunt.
`name`	String	De weergavenaam van het project.
`selected_project_type`	String	Het type van het project, bijvoorbeeld `axe-devtools-watcher` of `axe-devtools-html`.
`role`	String	Uw rol in het project, bijvoorbeeld `admin`.
`created_at`	String	ISO 8601 UTC-tijdstempel voor wanneer het project is aangemaakt.
`last_session_created_at`	String	ISO 8601 UTC-tijdstempel van de meest recente sessie van het project. `null` wanneer het project geen sessies heeft.
`has_git_information`	Boolean	Of het project geassocieerde Git-metagegevens heeft.
`git_url`	String	Git repository URL geassocieerd met het project. `null` wanneer het project geen Git-informatie heeft.
`latest_session`	Object	Details van de meest recente sessie van het project, of `null` wanneer het project geen sessies heeft. Om sessies van een project op te sommen, gebruik de Sessies eindpunt in plaats van dit veld.

Voorbeeld van reactie-inhoud

[
  {
    "project_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "webapp-ci",
    "selected_project_type": "axe-devtools-watcher",
    "role": "admin",
    "created_at": "2026-06-01T14:23:00.000Z",
    "last_session_created_at": "2026-06-14T09:12:00.000Z",
    "has_git_information": true,
    "git_url": "https://github.com/example/webapp",
    "latest_session": {
      "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",
    "role": "admin",
    "created_at": "2026-05-20T08:00:00.000Z",
    "last_session_created_at": null,
    "has_git_information": false,
    "git_url": null,
    "latest_session": null
  }
]

Cursor Paginering

Paginering is opt-in. Een verzoek dat noch page_size noch after verzendt, retourneert uw volledige projectlijst in één enkele reactie, zonder cursorheader, precies alsof deze parameters niet bestaan.

Om door resultaten te bladeren, gebruikt het Projects-eindpunt dezelfde cursor-gebaseerde paginering als de Sessies eindpunt: wanneer er meer resultaten zijn dan de huidige pagina, wordt een ondoorzichtige cursorwaarde geretourneerd in de x-pagination-cursor responseheader. Geef deze waarde door als de after queryparameter in uw volgende verzoek om de volgende pagina op te halen.

Wanneer de x-pagination-cursor header afwezig is in de reactie, heeft u de laatste pagina bereikt.

Zoek een project-ID op naam

Dit voorbeeld gebruikt curl en jq om de ID van een project te vinden op basis van de 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 van het Projects-eindpunt

Status	Oorzaak
`400 Bad Request`	De `project_types` waarde bevat een ongeldig projecttype, de `after` cursor is verkeerd gevormd, of `page_size`/`after` werd herhaald in de queryreeks.
`401 Unauthorized`	De API-sleutel is ongeldig, ontbreekt, of het bijbehorende abonnement is inactief.