Comience con la automatización de gestión de proyectos

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

Use su clave API de Axe Account existente para automatizar la gestión de proyectos y membresías

Not for use with personal data

Si su organización gestiona un gran número de proyectos en el Hub de Desarrolladores de Axe, o recibe y despide frecuentemente a colaboradores, puede automatizar ese trabajo con la API de Proyectos en lugar de hacer clic en la interfaz del Hub de Desarrolladores de Axe.

note

No hay ninguna credencial nueva que configurar. La automatización de gestión utiliza la misma clave API de Axe Account que ya utiliza para el resto de las APIs REST del Hub de Desarrolladores de Axe. Esto incluye la API de Sesiones y Resultados y la API de Estado de Commit. Si ya puede enviar resultados de pruebas al Hub de Desarrolladores de Axe, ya tiene lo que necesita.

Qué Puede Automatizar

Usando su clave API, su automatización puede:

Crear, actualizar y eliminar proyectos.
Listar cada proyecto en su organización (como administrador de la organización) o cada proyecto al que usted pertenece.
Listar los miembros de un proyecto, añadir un miembro con un rol, cambiar el rol de un miembro y eliminar un miembro.

Consulte la Referencia de API de Proyectos para obtener detalles completos de solicitudes y respuestas para cada operación.

Antes de Comenzar

Creando un proyecto requiere una suscripción activa (licencia) para ese tipo de proyecto. Quien crea un proyecto se convierte automáticamente en su administrador del proyecto.
Roles del proyecto son administrador y miembro. Un administrador de proyecto puede actualizar o eliminar el proyecto y gestionar su membresía. Un miembro de proyecto puede acceder al proyecto pero no gestionarlo o su membresía.
Administradores de Organización pueden ver y gestionar cada proyecto de los tipos con licencia de su organización, independientemente de su propia membresía en el proyecto. No necesitan una licencia personal para ver, actualizar, eliminar o gestionar los miembros de un proyecto existente. Crear un proyecto es la única excepción: siempre requiere una licencia activa, ya sea que la persona que llama sea un administrador de la organización o no.
Añadir un miembro a un proyecto no requiere que dicho miembro tenga una licencia. La API los registra inmediatamente como miembros del proyecto, pero no pueden acceder al proyecto hasta que tengan una licencia. El usuario objetivo ya debe pertenecer a la organización. No puede añadir a alguien que no sea ya miembro de la organización.
Eliminar un proyecto es definitivo. No hay una restauración automática para un proyecto eliminado.

Cada tipo de proyecto acepta solo valores específicos de test_language y test_platform, que se listan en Valores de Configuración del Tipo de Proyecto. Elija cuidadosamente el tipo: el tipo de un proyecto no puede cambiarse después de haber sido creado.

Obtenga su Clave API

Inicie sesión en el Portal de Cuenta de Axe.
Copie una clave API del Hub de Desarrolladores de Axe para proyectos web o CI/CD, o una clave API de Axe DevTools Mobile para proyectos móviles. Use el valor del encabezado X-API-Key de esta clave en cada solicitud a la API de Proyectos.

Cree Su Primer Proyecto Automáticamente

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 respuesta incluye el nuevo project_id. Guárdelo: lo necesitará para cada llamada subsiguiente con respecto a este proyecto, incluyendo el envío de resultados de pruebas.

Agregue Compañeros al Proyecto

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"

Identifique a cada usuario por su dirección de correo electrónico de Axe Account. El usuario objetivo ya debe pertenecer a su organización. Añadirlos no requiere que tengan una licencia, pero no pueden acceder al proyecto hasta que lo hagan.

Próximos Pasos

Referencia de API de Proyectos para la referencia completa de terminales, incluyendo consultas, actualizaciones y eliminación de proyectos, y la gestión de membresías a escala con las operaciones por lote.
Referencia de API de Sesiones y Resultados para recuperar resultados de accesibilidad una vez que sus proyectos automatizados los estén generando.