🧩 Obtener IDs de usuarios y equipos mediante API
Esta referencia explica cómo obtener usuarios y equipos, incluyendo sus identificadores únicos (IDs), a través de la API de Valuestreamer. Estos IDs son necesarios para otras acciones dentro de la API (por ejemplo: permisos, asignaciones, detalles de equipos).
🔍 Resumen de endpoints disponibles
Propósito: Obtener todos los usuarios
Método HTTP: GET
Endpoint: /api/exchange/users
Propósito: Obtener todos los equipos
Método HTTP: GET
Endpoint: /api/exchange/teams
Propósito: Obtener detalles de un equipo específico
Método HTTP: GET
Endpoint: /api/exchange/teams/{teamId}
👤 Obtener usuarios
📌 Solicitud
GET https://api-TENANT.valuestreamer.de/api/exchange/users
(Nota: Reemplace TENANT por el dominio de su tenant.)
📥 Ejemplo de respuesta (simplificado)
[
{
"id": "UUID-USER-1",
"firstName": "Max",
"lastName": "Mustermann",
"email": "max.mustermann@example.de"
},
{
"id": "UUID-USER-2",
"firstName": "Maria",
"lastName": "Musterfrau",
"email": "maria.musterfrau@example.de"
}
]
Descripción de los campos
id – ID único del usuario (UUID), utilizado en otras llamadas de API
firstName – Nombre del usuario
lastName – Apellido del usuario
email – Correo electrónico del usuario
Nota: Los IDs son fijos y no pueden modificarse.
🧑🤝🧑 Obtener equipos
📌 Solicitud
GET https://api-TENANT.valuestreamer.de/api/exchange/teams
📥 Ejemplo de respuesta (simplificado)
[
{
"id": "UUID-TEAM-1",
"name": "Equipo Alfa",
"shortName": "Alfa",
"parentTeam": null
},
{
"id": "UUID-TEAM-2",
"name": "Equipo Beta",
"shortName": "Beta",
"parentTeam": "UUID-TEAM-1"
}
]
Descripción de los campos
id – ID único del equipo (UUID)
name – Nombre completo del equipo
shortName – Nombre corto del equipo
parentTeam – UUID del equipo padre (si existe)
Nota: Los equipos pueden tener jerarquías. parentTeam = null indica que no hay un equipo superior.
📋 Obtener detalles de un equipo específico
Utilice este endpoint para ver los miembros del equipo y los tableros de proceso asignados.
📌 Solicitud
GET https://api-TENANT.valuestreamer.de/api/exchange/teams/{teamId}
(Reemplace {teamId} por el ID real del equipo que desea consultar.)
📥 Ejemplo de respuesta (resumido)
{
"id": "UUID-TEAM-DETAIL",
"name": "Equipo Gamma",
"shortName": "Gamma",
"parentTeam": "UUID-TEAM-0",
"members": [
{
"id": "UUID-USER-A",
"firstName": "Anna",
"lastName": "Ejemplo",
"email": "anna.ejemplo@example.de"
},
{
"id": "UUID-USER-B",
"firstName": "Ben",
"lastName": "Ejemplo",
"email": "ben.ejemplo@example.de"
}
],
"processBoards": [
{
"id": "UUID-PROCESS-1",
"name": "Proceso X"
}
]
}
Descripción de los campos
members – Lista de miembros del equipo con datos de usuario
processBoards – Lista de tableros de proceso asignados al equipo
✨ Consejo: Utilice los detalles del equipo para gestionar roles, permisos o procesos a nivel de equipo de forma automática.
❓ Preguntas frecuentes
¿Cómo puedo saber qué ID corresponde a qué equipo?
Utilice el endpoint /teams para obtener todos los equipos y utilice sus nombres como referencia.