Ir al contenido
AdiosDocumentación
Explorar la documentación

API de inicio rápido

Empieza por la salud de la API y comprueba después tu token bearer y el contexto del equipo.

Usa Autenticación de la API para las solicitudes protegidas. Los ejemplos usan tus propios IDs de recursos y un token temporal; las respuestas de ejemplo guardadas son sintéticas.

MétodoRutaOperación
GET/v1/healthComprobar salud de la API
GET/v1/auth/meObtener usuario actual

Comprobar salud de la API

GET /v1/health

Comprueba si responde el proceso de la API.

Autenticación: pública; no requiere token bearer.

Ejemplo de solicitud

Configura ADIOS_API_URL=https://api.adios.dev. Para las solicitudes protegidas, configura ADIOS_ACCESS_TOKEN y ADIOS_TEAM_ID como en el inicio rápido. Configura las variables adicionales ADIOS_* a partir de los resultados de tus propios recursos.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/health"

Respuesta: HTTP 200

Respuesta correcta. Inspecciona el estado devuelto por las operaciones que inician trabajo asíncrono.

Ejemplo ilustrativo; no es una respuesta real:

{
  "status": "ok"
}

Obtener usuario actual

GET /v1/auth/me

Devuelve tu user_id, perfil, equipos y team_data. El script de respuesta solo guarda user_id en el entorno seleccionado. Configura tú mismo team_id con el equipo activo de la CLI antes de usar un token de diagnóstico.

Autenticación: token bearer y la cabecera de equipo que se muestra a continuación.

Parámetros

NombreUbicaciónObligatorioDescripción
X-Tenant-IDcabecerasíID del equipo activo. Debe coincidir con el tenant vinculado al token de diagnóstico.

Ejemplo de solicitud

Configura ADIOS_API_URL=https://api.adios.dev. Para las solicitudes protegidas, configura ADIOS_ACCESS_TOKEN y ADIOS_TEAM_ID como en el inicio rápido. Configura las variables adicionales ADIOS_* a partir de los resultados de tus propios recursos.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/auth/me" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Respuesta: HTTP 200

Respuesta correcta. Inspecciona el estado devuelto por las operaciones que inician trabajo asíncrono.

No se publica un esquema completo del cuerpo de respuesta para esta operación personalizada. Inspecciona el contenido y el estado devueltos; aquí no se presupone ningún payload.