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 tu organización gestiona un gran número de proyectos en Axe Developer Hub, o incorpora y retira contribuyentes frecuentemente, puedes automatizar ese trabajo con la API de Proyectos en lugar de navegar por la interfaz de usuario de Axe Developer Hub.

note

No hay nuevas credenciales que configurar. La automatización de gestión utiliza la misma clave API de Axe Account que ya usas para el resto de las APIs REST de Axe Developer Hub. Esto incluye la API de Sesiones y Resultados y la API de Estado de Commit. Si ya puedes enviar resultados de pruebas a Axe Developer Hub, ya tienes lo que necesitas.

Lo que Puedes Automatizar

Usando tu clave API, tu automatización puede:

Crear, actualizar y eliminar proyectos.
Listar todos los proyectos de tu organización (como administrador de la organización) o todos los proyectos a los que perteneces.
Listar los miembros de un proyecto, añadir un miembro con un rol, cambiar el rol de un miembro y eliminar un miembro.

Consulta la Referencia de API de Proyectos para obtener todos los detalles de solicitud y respuesta de cada operación.

Antes de Comenzar

Crear un proyecto requiere una suscripción activa (licencia) para el tipo de proyecto. Quien cree un proyecto se convierte automáticamente en su administrador del proyecto.
Roles de proyecto son admin y miembro. Un administrador de proyecto puede actualizar o eliminar el proyecto y gestionar sus miembros. Un miembro de proyecto puede acceder al proyecto, pero no gestionarlo ni gestionar a sus miembros.
Administradores de la Organización pueden ver y gestionar cada proyecto de los tipos licenciados de su organización, independientemente de su propia pertenencia al 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 el solicitante sea un administrador de la organización o no.
Añadir un miembro a un proyecto no requiere que ese miembro tenga una licencia. La API los registra como miembros del proyecto inmediatamente, pero no pueden acceder al proyecto hasta que posean una licencia. El usuario objetivo debe ya pertenecer a la organización. No puedes añadir a alguien que no sea ya miembro de la organización.
Eliminar un proyecto es definitivo. No hay una opción de auto-restitución para un proyecto eliminado.

Cada tipo de proyecto acepta solo valores específicos test_language y test_platform, listados en Valores de Configuración del Tipo de Proyecto. Elige el tipo cuidadosamente: el tipo de un proyecto no puede cambiar una vez creado.

Obtén tu Clave API

Inicia sesión en el Portal de Cuentas Axe.
Copia una clave API de Axe Developer Hub para proyectos web o CI/CD, o una clave API de Axe DevTools Mobile para proyectos móviles. Usa el valor del encabezado de esta clave X-API-Key en cada solicitud al API de Proyectos.

Crea tu 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árdalo: lo necesitarás para cada llamada subsiguiente contra este proyecto, incluyendo el envío de resultados de pruebas.

Añadir 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"

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

Próximos Pasos

Comienza con las APIs de Axe Developer Hub para autenticación, manejo de errores y las otras tareas que puedes automatizar con la misma clave API.
Referencia de API de Proyectos para la referencia completa de los puntos finales, incluyendo la recuperación, actualización y eliminación de proyectos, y la gestión masiva de miembros con las operaciones por lotes.
Referencia de API de Sesiones y Resultados para recuperar resultados de accesibilidad una vez que tus proyectos automatizados los estén produciendo.