API Rest te permite integrar cualquiera de tus aplicaciones para automatizar procesos e información.
Para comunicarte con nuestro servicio debes autenticarte mediante un esquema OAuth. Como primer paso debes generar un Token de acceso tipo JWT.
El listado completo de operaciones se encuentra en https://www.plaspy.com/rest-api-docs
Recursos
| Operación | Endpoint | Descripción |
|---|---|---|
| Autenticación | /api/Auth/Token | Obtener Auth token |
| Dispositivos | /api/devices | Listar dispostivos activos en la cuenta |
| Dispositivo | /api/device/{deviceId} | Información sobre un dispositivo |
| Última ubicación | /api/device/{deviceId}/LastLocation | Última ubicación de un dispositivo registrada por Plaspy |
| Ubicaciones | /api/device/{deviceId}/Locations | Ubicaciones de un dispositivo en un rango de fechas |
| Alertas | /api/device/{deviceId}/Alerts | Alertas generadas por el dispositivo en un rango de fechas |
Códigos de estado HTTP
| Código | Mensaje | Descripción |
|---|---|---|
| 200 | OK | La solicitud ha tenido éxito. |
| 201 | Created | La solicitud ha tenido éxito y se ha creado un nuevo recurso como resultado de ello. |
| 400 | Bad Request | Existe un problema en el lado del cliente, es necesario validar los parámetro. |
| 401 | Unauthorized | No se ha proporcionado ningún token válido. |
| 403 | Forbidden | El usuario asociado con el token no tiene permisos para realizar la solicitud. |
| 404 | Not Found | El recurso solicitado no existe. |
| 408 | Request Timeout | Rest API no logró completar la solicitud dentro del tiempo que estaba preparado para esperar. |
| 409 | Conflict | Solicitud HTTP válida, pero se está intentando poner los recursos del servidor en un estado imposible o inconsistente. |
| 415 | Unsupported media type | Se envió un media type no soportado. El servidor podría haber estado esperando JSON. |
| 429 | Too Many Requests | Se han enviado demasiadas solicitudes en un corto periodo de tiempo o en un rango de tiempo. |
| 500 | Internal Server Error | Error no controlado durante el proceso de la solicitud. |
| 503 | Service Unavailable | Rest API actualmente no está disponible debido a una sobrecarga temporal o mantenimiento programado. |
Manejo de errores
Los errores en el Rest API tienen la siguiente estructura:
"success": true,
"error": "string"
}
- success: falso cuando se produce un error en la petición.
- error: Mensaje con la explicación del error.
Límite de solicitudes
Es importante tener en cuenta en el momento de la integración, que se pueden enviar como máximo 60 peticiones por minuto al API, ademas de contar con un límite 25.000 resultados por dispositivo diario.
- Bienvenido a la Ayuda de Plaspy
- Mapa
- Reportes
- Herramientas del mapa
- Como mostrar un recorrido
- Geocercas
- Alertas
- Cálculo de kilometraje
- Atributos
- Habilitar las notificaciones
- Estadísticas
- Resumen de actividades
- Dispositivos
- Alertas
- Generar alertas específicas
- Generar alerta SOS
- Habilitar las notificaciones de Telegram
- Configurar rastreador por primera vez
- Límites de envío de alertas por correo electrónico
- Grupos
- Usuarios
- Acceso compartido
- Configuración
- SMS
- Mi cuenta
- Código de Activación
- Renovación de Líneas
- Redención de puntos
- Métodos de pago
- Cómo realizar el pago por la plataforma
- Aplicación Móvil
- Desarrolladores
- Activación API
- Activación API
- Rest API
- Dispositivos
- Dispositivo
- Última ubicación
- Ubicaciones
- Alertas
- Autenticación
- Insertar en mi página web
- Insertar el mapa en mi página web
- Aplicación móvil
- Aplicación móvil avanzada
- Aplicación móvil con notificaciones Push
- API (Obsoleta)
- Operaciones y resultado
- Formato de los peticiones y respuestas
- Ejemplo
- Código de ejemplos
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).