Obtener Agente
GEThttps://{environment}.metrocuadrado.com/rest-api/agents/
Obtiene el listado de agentes disponibles.
Ambientes Disponibles
| Ambiente | URL Base |
|---|---|
| Desarrollo | https://ptec-core-dev.metrocuadrado.com/rest-api/agents/ |
| Producción | https://www.metrocuadrado.com/rest-api/agents/ |
Autenticación
| Header | Valor | Requerido | Descripción |
|---|---|---|---|
| Content-Type | application/json | Sí | Tipo de contenido |
| x-api-key | string | Sí | API key de autenticación |
| token | string | Sí | Token JWT de acceso |
Ejemplos
- Request Desarrollo
- Request Producción
- 200 OK
- 401 Unauthorized
curl -X GET \
'https://ptec-core-dev.metrocuadrado.com/rest-api/agents/' \
-H 'Content-Type: application/json' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'token: tu-jwt-token'
curl -X GET \
'https://www.metrocuadrado.com/rest-api/agents/' \
-H 'Content-Type: application/json' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'token: tu-jwt-token'
{
"data": [
{
"id": 1,
"name": "Agente Ejemplo",
"email": "agente@metrocuadrado.com"
}
]
}
{
"error": "Token de autorización inválido o expirado"
}
Notas Importantes
- Requiere un token JWT válido (generar en el endpoint de autenticación)
- La API Key debe corresponder al ambiente seleccionado
- Todos los campos marcados como requeridos deben enviarse
- No requiere parámetros adicionales
- El listado incluye todos los agentes disponibles
Cómo Probar
Para probar este endpoint, sigue estos pasos:
- Genera un token JWT usando el endpoint de autenticación
- Asegúrate de usar la API Key correcta según el ambiente
- Incluye el token en el header
token - Realiza la petición GET al endpoint correspondiente
Códigos de Respuesta
| Código | Descripción |
|---|---|
| 200 | Listado de agentes obtenido |
| 401 | Token inválido o expirado |
Probar Endpoint
API Tester
Prueba los endpoints de forma interactiva