Documentación de la API
La API REST de WardOps te permite integrar tu sistema con nuestra plataforma de gestión de seguridad privada. Utiliza esta API como puente de comunicación entre tus sistemas externos y WardOps.
Inicio rápido
Realiza tu primera llamada a la API en menos de 5 minutos.
Ejemplo de petición
curl --request GET \
--url https://api.wardops.com/v1/guards \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json'URL Base
Todas las peticiones deben realizarse a la siguiente URL base:
https://api.wardops.com/v1La API utiliza HTTPS exclusivamente. Todas las peticiones HTTP serán redirigidas automáticamente.
Guardias
Endpoints para gestionar la informacion de los guardias de seguridad.
Listar guardias
Obtiene una lista paginada de todos los guardias registrados en tu organizacion.
Parametros de Query
| Parametro | Tipo | Requerido | Descripcion |
|---|---|---|---|
page | integer | No | Numero de paginaEjemplo: 1 |
per_page | integer | No | Resultados por pagina (max 100)Ejemplo: 25 |
status | string | No | Filtrar por estado: active, inactive, allEjemplo: active |
search | string | No | Buscar por nombre o identificacionEjemplo: Juan |
Ejemplo de peticion
curl --request GET \
--url 'https://api.wardops.com/v1/guards?page=1&per_page=25&status=active' \
--header 'Authorization: Bearer YOUR_API_KEY'Respuestas
{
"data": [
{
"id": "grd_123abc",
"first_name": "Juan",
"last_name": "Perez",
"email": "juan.perez@example.com",
"phone": "+52 55 1234 5678",
"status": "active",
"employee_id": "EMP-001",
"certifications": ["armed_guard", "first_aid"],
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-20T14:22:00Z"
}
],
"meta": {
"current_page": 1,
"per_page": 25,
"total": 150,
"total_pages": 6
}
}{
"error": {
"code": "unauthorized",
"message": "API key is invalid or missing"
}
}Asignaciones y Turnos
Endpoints para gestionar las asignaciones de turnos y horarios de los guardias.
Check-ins y ubicación
Endpoints para registrar check-ins, check-outs y actualizar la ubicacion de los guardias.
Reportes
Endpoints para gestionar reportes de incidentes y novedades.
Comunicación en tiempo real
WardOps ofrece conexiones WebSocket para recibir actualizaciones en tiempo real. Utiliza esta funcionalidad como puente de comunicacion entre sistemas.
wss://api.wardops.com/v1/ws?token=YOUR_API_KEYEjemplo de conexion
const socket = new WebSocket(
'wss://api.wardops.com/v1/ws?token=YOUR_API_KEY'
);
socket.onopen = () => {
console.log('Conectado');
// Suscribirse a eventos de ubicacion
socket.send(JSON.stringify({
action: 'subscribe',
channel: 'locations'
}));
};
socket.onmessage = (event) => {
const data = JSON.parse(event.data);
console.log('Evento recibido:', data);
};
socket.onerror = (error) => {
console.error('Error:', error);
};Canales disponibles
| Canal | Descripcion |
|---|---|
locations | Actualizaciones de ubicacion de guardias |
checkins | Eventos de check-in y check-out |
alerts | Alertas y notificaciones del sistema |
reports | Nuevos reportes creados |
shifts | Cambios en turnos y asignaciones |
Formato de eventos
{
"event": "location.updated",
"timestamp": "2024-01-25T08:15:00Z",
"data": {
"guard_id": "grd_123abc",
"latitude": 19.4326,
"longitude": -99.1332,
"accuracy": 10.5
}
}Push Notifications
Para configurar notificaciones push en dispositivos moviles, visita la seccion de Webhooks donde puedes registrar endpoints para recibir eventos y enviar notificaciones a tus propios sistemas.
Rate Limiting
La API implementa rate limiting para garantizar la estabilidad del servicio.
| Plan | Limite | Ventana |
|---|---|---|
| Starter | 1,000 requests | por hora |
| Professional | 10,000 requests | por hora |
| Enterprise | Ilimitado | - |
Headers de respuesta
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1706176800Manejo de Errores
La API utiliza codigos HTTP estandar y devuelve errores en formato JSON.
{
"error": {
"code": "validation_error",
"message": "The given data was invalid",
"details": {
"email": ["The email field is required"],
"phone": ["The phone format is invalid"]
}
}
}| Codigo | Descripcion |
|---|---|
400 | Bad Request - Peticion malformada |
401 | Unauthorized - API Key invalida o faltante |
403 | Forbidden - Sin permisos para este recurso |
404 | Not Found - Recurso no encontrado |
422 | Unprocessable Entity - Error de validacion |
429 | Too Many Requests - Rate limit excedido |
500 | Internal Server Error - Error del servidor |
¿Listo para comenzar?
Obtén tu API Key y comienza a integrar WardOps con tus sistemas.