Para interactuar con la API REST de Plaspy, es necesario autenticarse utilizando un esquema de autenticación OAuth. El proceso de autenticación asegura que solo los usuarios autorizados puedan acceder a los recursos de la API. En este documento se explica cómo generar un token de autenticación (JWT) y cómo utilizarlo para realizar solicitudes a otros endpoints de la API.
La autenticación es un paso crucial para asegurar que solo los usuarios autorizados puedan acceder a la API REST de Plaspy. Siguiendo los pasos mencionados, puedes generar un token de autenticación y utilizarlo para interactuar con los diferentes endpoints de la API de manera segura y eficiente. Para más detalles sobre otras operaciones, consulta la documentación completa de la API REST de Plaspy .
Endpoint de Autenticación
Obtener el Token de Autenticación
El token de autenticación se obtiene mediante una solicitud POST al endpoint /api/Auth/Token. A continuación, se detallan los pasos para realizar esta solicitud.
Detalles de la Solicitud
- Endpoint:
/api/Auth/Token - Método:
POST - Encabezado:
Content-Type: application/json - Base URL:
https://api.plaspy.com
Parámetros de la Solicitud
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
| userName | String | Sí | Tu nombre de usuario en Plaspy. |
| apiKey | String | Sí | Tu clave de API proporcionada por Plaspy. |
Cuerpo de la Solicitud
{
"userName": "tu_nombre_de_usuario",
"apiKey": "tu_api_key"
}
Ejemplo de Solicitud
POST /api/Auth/Token HTTP/1.1
Host: api.plaspy.com
Content-Type: application/json
{
"userName": "tu_nombre_de_usuario",
"apiKey": "tu_api_key"
}
Parámetros de Respuesta
| Parámetro | Tipo | Descripción |
|---|---|---|
| success | Boolean | Indica si la solicitud fue exitosa (true o false). |
| token | String | El token de autenticación JWT. |
| expires | String | La fecha y hora de expiración del token. |
| error | String | Mensaje explicando la causa del error (si aplica). |
Ejemplo de Respuesta Exitosa
{
"success": true,
"token": "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXV...",
"expires": "2023-12-31T23:59:59Z"
}
Ejemplo de Respuesta de Error
{
"success": false,
"error": "Invalid API key or username."
}
Usar el Token de Autenticación
Una vez obtenido el token de autenticación, este debe incluirse en el encabezado Authorization de todas las solicitudes a la API. El formato del encabezado es Authorization: Bearer tu_token.
Ejemplo de Solicitud con Token
GET /api/devices
HTTP/1.1
Host: api.plaspy.com
Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXV...
Manejo de Errores
Si la solicitud para obtener el token de autenticación falla, la respuesta incluirá un mensaje de error explicando la causa del fallo.
Ejemplo de Respuesta de Error
{
"success": false,
"error": "Invalid API key or username."
}
- success: Indica que la solicitud falló (
false). - error: Mensaje que explica la causa del error.
Consideraciones de Seguridad
- Protección del Token: Mantén tu token de autenticación seguro y no lo compartas con terceros no autorizados.
- Renovación del Token: El token tiene una fecha de expiración (
expires). Asegúrate de renovarlo antes de que expire para mantener el acceso continuo a la API.
- Bienvenido a la Ayuda de Plaspy
- Mapa
- Consultar el Historial de Recorridos de un Dispositivo
- Panel de Control de Dispositivos
- Información Detallada del Dispositivo
- Botones sobre el mapa
- Detalles
- Estadísticas de Recorridos
- Menú de Dispositivos
- Geocercas
- Edición Masiva de Alertas
- Habilitar las notificaciones
- Cálculo de kilometraje
- Atributos
- Dispositivos
- Personalizar marcador
- Información
- Sensores
- Reasignar sensores digitales
- Comandos
- Recordatorios
- Alertas
- Tipos
- Configuración
- Límites
- Historial
- Configuración de un Nuevo Rastreador
- Solución para identificador ya en uso en otra cuenta
- Problemas con el Dispositivo
- Límites de envío de alertas por correo electrónico
- Reportes
- Nuevo Reporte
- Mi cuenta
- Información de facturación
- Cambio de Contraseña
- Notificaciones por Email
- Cuentas de Telegram
- Modificar Teléfono Móvil
- Correo Electrónico Principal
- Correo Electrónico Alternativo
- Activar autenticación de dos factores (2FA)
- Registro de Acceso
- Recordar Contraseña
- Recordar Usuario
- Eliminar tu cuenta
- Subscripción
- Registro en Plaspy
- Código de Activación
- Métodos de pago
- Renovación de Líneas
- Versión Gratis
- Configuración
- Organización
- Ingreso
- Contacto
- Estilos
- Mapas
- Plantillas de correo electrónico
- Notificaciones Push
- Notificaciones Telegram
- Notificaciones WhatsApp
- Aplicación móvil
- Estadísticas
- Resumen de actividades
- Grupos
- Usuarios
- Acceso temporal
- SMS
- Aplicación Móvil
- Desarrolladores
- Activación API
- Rest API
- Autenticación
- Dispositivos API
- GET /api/devices/{deviceId}
- GET /api/devices/{deviceId}/lastLocation
- POST /api/devices/{deviceId}/locations
- POST /api/devices/{deviceId}/alerts
- GET /api/devices
- Grupos API
- GET /api/groups
- POST /api/groups
- PUT /api/groups/{groupId}
- DELETE /api/groups/{groupId}
- GET /api/groups/{groupId}
- PATCH /api/groups/{groupId}
- Users API
- GET /api/users
- POST /api/users
- GET /api/users/countries
- GET /api/users/timeZones
- GET /api/users/{userId}
- PUT /api/users/{userId}
- DELETE /api/users/{userId}
- PATCH /api/users/{userId}
- Insertar en mi página web
- Insertar el mapa en mi página web
Respondemos todas las solicitudes de soporte en 24 horas en días hábiles. Responderemos tan pronto como sea posible!
Estamos ubicados en Bogotá, Colombia, ten en cuenta la zona horaria (GMT-5).