Obtener Sucursales
GEThttps://{environment}.metrocuadrado.com/rest-api/offices/
Obtiene el listado completo de sucursales disponibles en el sistema.
Ambientes Disponibles
| Ambiente | URL |
|---|---|
| Desarrollo | https://ptec-core-dev.metrocuadrado.com/rest-api/offices/ |
| Producción | https://www.metrocuadrado.com/rest-api/offices/ |
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
- 200 OK
- 401 Unauthorized
curl -X GET \
'https://ptec-core-dev.metrocuadrado.com/rest-api/offices/' \
-H 'Content-Type: application/json' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'token: tu-jwt-token'
{
"data": [
{
"id": 1,
"name": "Sucursal Centro",
"address": "Calle Principal #123",
"phone": "601-1234567",
"city": "Bogotá",
"status": "active"
},
{
"id": 2,
"name": "Sucursal Norte",
"address": "Avenida Norte #456",
"phone": "601-7654321",
"city": "Bogotá",
"status": "active"
}
]
}
{
"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
- No requiere parámetros adicionales
- El listado incluye todas las sucursales activas
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 sucursales obtenido |
| 401 | Token inválido o expirado |
Probar Endpoint
API Tester
Prueba los endpoints de forma interactiva