Autenticación de la API
Aprende como autenticar tus peticiones a la API de WardOps. Ofrecemos multiples metodos de autenticacion para adaptarnos a tus necesidades.
API Keys
La forma mas sencilla de autenticarte. Ideal para integraciones servidor a servidor.
- Inicia sesion en tu cuenta de WardOps
- Ve a Configuracion → API
- Haz clic en Generar nueva API Key
- Asigna un nombre descriptivo y selecciona los permisos necesarios
- Copia y guarda tu API Key en un lugar seguro
Importante
Tu API Key solo se mostrara una vez. Si la pierdes, deberas generar una nueva.
Usando tu API Key
Incluye tu API Key en el header Authorization de cada peticion:
curl --request GET \
--url 'https://api.wardops.com/v1/guards' \
--header 'Authorization: Bearer sk_live_your_api_key_here' \
--header 'Content-Type: application/json'Tipos de API Keys
sk_live_Utiliza estas keys para tu entorno de produccion. Todas las operaciones afectaran datos reales.
sk_test_Utiliza estas keys para desarrollo y pruebas. Los datos son aislados y pueden reiniciarse.
Permisos de API Key
Puedes configurar permisos granulares para cada API Key:
| Permiso | Descripcion | Endpoints |
|---|---|---|
guards:read | Leer informacion de guardias | GET /guards |
guards:write | Crear y modificar guardias | POST, PUT, DELETE /guards |
assignments:read | Leer asignaciones | GET /assignments |
assignments:write | Crear y modificar asignaciones | POST, PUT /assignments |
locations:read | Leer ubicaciones | GET /location/* |
locations:write | Actualizar ubicaciones | POST /location/* |
reports:read | Leer reportes | GET /reports |
reports:write | Crear reportes | POST /reports |
webhooks:manage | Gestionar webhooks | * /webhooks |
OAuth 2.0
Para aplicaciones que acceden a datos de multiples organizaciones o requieren autenticacion de usuarios.
Redirigir al usuario
Redirige al usuario a la pagina de autorizacion de WardOps
https://app.wardops.com/oauth/authorize?
client_id=YOUR_CLIENT_ID
&redirect_uri=https://yourapp.com/callback
&response_type=code
&scope=guards:read assignments:read
&state=random_state_stringRecibir codigo de autorizacion
Despues de que el usuario autorice, sera redirigido a tu callback
https://yourapp.com/callback?code=AUTH_CODE&state=random_state_stringIntercambiar por access token
Intercambia el codigo por un access token
curl --request POST \
--url 'https://api.wardops.com/oauth/token' \
--header 'Content-Type: application/json' \
--data '{
"grant_type": "authorization_code",
"client_id": "YOUR_CLIENT_ID",
"client_secret": "YOUR_CLIENT_SECRET",
"code": "AUTH_CODE",
"redirect_uri": "https://yourapp.com/callback"
}'Usar el access token
Usa el token para hacer peticiones autenticadas
{
"access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
"token_type": "Bearer",
"expires_in": 3600,
"refresh_token": "rt_abc123...",
"scope": "guards:read assignments:read"
}Refrescar el token
Los access tokens expiran despues de 1 hora. Usa el refresh token para obtener uno nuevo:
curl --request POST \
--url 'https://api.wardops.com/oauth/token' \
--header 'Content-Type: application/json' \
--data '{
"grant_type": "refresh_token",
"client_id": "YOUR_CLIENT_ID",
"client_secret": "YOUR_CLIENT_SECRET",
"refresh_token": "rt_abc123..."
}'JWT Tokens
Genera tokens JWT para autenticar usuarios de tu aplicacion con WardOps.
Los tokens JWT de WardOps contienen la siguiente informacion:
Header
{
"alg": "RS256",
"typ": "JWT"
}Payload
{
"sub": "usr_abc123",
"org_id": "org_xyz789",
"email": "usuario@example.com",
"scopes": ["guards:read", "assignments:write"],
"iat": 1706176800,
"exp": 1706180400,
"iss": "https://api.wardops.com"
}| Campo | Descripcion |
|---|---|
sub | ID unico del usuario |
org_id | ID de la organizacion |
scopes | Permisos otorgados |
iat | Timestamp de emision |
exp | Timestamp de expiracion |
iss | Emisor del token |
Verificar tokens
Puedes obtener la clave publica para verificar los tokens en:
GET https://api.wardops.com/.well-known/jwks.jsonRate Limiting
La API implementa limites de peticiones para garantizar la estabilidad del servicio.
| Plan | Requests/hora | Requests/minuto |
|---|---|---|
| Starter | 1,000 | 60 |
| Professional | 10,000 | 300 |
| Enterprise | Ilimitado* | 1,000 |
* Sujeto a uso razonable. Contacta soporte para necesidades especiales.
Headers de rate limit
Cada respuesta incluye headers informativos sobre tu uso:
HTTP/1.1 200 OK
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 995
X-RateLimit-Reset: 1706180400
X-RateLimit-Retry-After: 3600| Header | Descripcion |
|---|---|
X-RateLimit-Limit | Limite total de peticiones |
X-RateLimit-Remaining | Peticiones restantes |
X-RateLimit-Reset | Timestamp cuando se reinicia el contador |
X-RateLimit-Retry-After | Segundos para esperar (si excediste el limite) |
Respuesta cuando excedes el limite
{
"error": {
"code": "rate_limit_exceeded",
"message": "Has excedido el limite de peticiones",
"retry_after": 3600
}
}Mejores Practicas de Seguridad
Si sospechas que tu API Key fue comprometida
Revocala inmediatamente desde el panel de administracion y genera una nueva. Contacta a soporte si necesitas ayuda.
¿Listo para comenzar?
Genera tu primera API Key y comienza a integrar WardOps.