Cargando ...

Rest API

Una API REST (Representational State Transfer) es un conjunto de funciones que permite la comunicación y el intercambio de datos entre diferentes sistemas a través de la web. Utiliza métodos HTTP estándar como GET, POST, PUT, DELETE para realizar operaciones sobre recursos, representados en formato JSON. Las API REST son ampliamente utilizadas por su simplicidad, flexibilidad y escalabilidad.

La API REST de Secure GPS proporciona una manera robusta y segura de integrar las funcionalidades de Secure GPS en tus propias aplicaciones. Siguiendo las directrices anteriores, podrás realizar solicitudes eficientes y gestionar correctamente los errores y los límites de la API. Para más detalles, consulta la documentación completa de la API REST de Secure GPS .

Usos de una API REST

  • Integración de Sistemas: Permite que diferentes sistemas y aplicaciones se comuniquen y compartan datos de manera eficiente.
  • Automatización de Procesos: Facilita la automatización de tareas y flujos de trabajo.
  • Extensión de Funcionalidades: Permite a los desarrolladores agregar nuevas funcionalidades a las aplicaciones existentes sin necesidad de modificar el código base.
  • Desarrollo de Aplicaciones Móviles: Provee una manera fácil de conectar aplicaciones móviles a servicios backend.
  • Acceso Remoto a Servicios: Permite el acceso a servicios y datos desde cualquier lugar con conexión a internet.

Base URL de Peticiones

La base URL para todas las peticiones a la API REST de Secure GPS es:

https://api.plaspy.com

Método de Autenticación

Para comunicarte con el servicio de Secure GPS, debes autenticarte utilizando un esquema OAuth. El primer paso es generar un Token de acceso tipo JWT (JSON Web Token). Este token se obtiene a través de la siguiente operación:

  • Endpoint: /api/Auth/Token
  • Método: POST
  • Descripción: Obtener el Auth token necesario para realizar peticiones a otros endpoints de la API.

Cómo usar OAuth en Secure GPS

  1. Generar un Token de Autenticación:

    • Endpoint: /api/Auth/Token
    • Método: POST
    • Descripción: Obtener el Auth token necesario para realizar peticiones a otros endpoints de la API.
    • Ejemplo de solicitud:
      { "userName": "tu_nombre_de_usuario", "apiKey": "tu_api_key" }
  2. Incluir el Token en las Peticiones:

    • Una vez obtenido el token, debes incluirlo en el encabezado de cada solicitud a la API.
    • Encabezado: Authorization: Bearer tu_token
    • Ejemplo de uso en una petición GET:
      GET /api/devices HTTP/1.1
      Host: api.plaspy.com
      Authorization: Bearer tu_token

Operaciones

A continuación, se presenta una tabla con las operaciones disponibles en la API REST de Secure GPS:

Operación Método Endpoint Descripción
Obtener Token de Autenticación POST /api/Auth/Token Obtener el Auth token para realizar peticiones a otros endpoints.
Listar Dispositivos GET /api/devices Listar dispositivos activos en la cuenta.
Información de Dispositivo GET /api/devices/{deviceId} Obtener información sobre un dispositivo específico.
Última Ubicación GET /api/devices/{deviceId}/lastLocation Obtener la última ubicación registrada de un dispositivo.
Obtener Ubicaciones POST /api/devices/{deviceId}/locations Obtener ubicaciones de un dispositivo en un rango de fechas.
Obtener Alertas POST /api/devices/{deviceId}/alerts Obtener alertas generadas por un dispositivo en un rango de fechas.
Listar Grupos GET /api/groups Listar todos los grupos creados en la cuenta.
Crear Grupo POST /api/groups Crear un nuevo grupo.
Obtener Información de Grupo GET /api/groups/{groupId} Obtener información de un grupo específico.
Actualizar Grupo PUT /api/groups/{groupId} Actualizar información de un grupo específico.
Borrar Grupo DELETE /api/groups/{groupId} Borrar un grupo específico.
Listar Usuarios GET /api/users Listar usuarios registrados en la cuenta.
Crear Usuario POST /api/users Crear un nuevo usuario.
Obtener Información de Usuario GET /api/users/{userId} Obtener información de un usuario específico.
Actualizar Usuario PUT /api/users/{userId} Actualizar información de un usuario específico.
Borrar Usuario DELETE /api/users/{userId} Borrar un usuario específico.
Obtener Países GET /api/users/countries Obtener la lista de países disponibles.
Obtener Zonas Horarias GET /api/users/timeZones Obtener la lista de zonas horarias disponibles

Códigos de Estado HTTP

Código de Estado Descripción
200 OK La solicitud ha tenido éxito.
201 Created La solicitud ha tenido éxito y se ha creado un nuevo recurso.
400 Bad Request Existe un problema en el lado del cliente, es necesario validar los parámetros.
401 Unauthorized No se ha proporcionado un 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 La solicitud no se completó dentro del tiempo permitido.
409 Conflict Solicitud HTTP válida, pero se intenta poner los recursos del servidor en un estado imposible o inconsistente.
415 Unsupported Media Type Se envió un tipo de medio no soportado. El servidor esperaba JSON.
429 Too Many Requests Se han enviado demasiadas solicitudes en un corto periodo de tiempo.
500 Internal Server Error Error no controlado durante el proceso de la solicitud.
503 Service Unavailable La API no está disponible debido a una sobrecarga temporal o mantenimiento.

Manejo de Errores

Los errores en la API REST de Secure GPS tienen la siguiente estructura JSON:

{ "success": false, "error": "Mensaje con la explicación del error." }
  • success: false cuando se produce un error en la petición.
  • error: Mensaje que explica la causa del error.

Límite de Solicitudes

Es importante tener en cuenta los siguientes límites al integrar la API de Secure GPS:

  • Solicitudes por minuto: Máximo de 60 peticiones.
  • Resultados por dispositivo diario: Límite de 25,000 resultados.

Estos límites están diseñados para asegurar el rendimiento y la estabilidad del sistema.

Índice
Última modificación: 2024-06-03 16:36:27