Documentación Endpoint Smart Report

Especificaciones para entrega de data GPS a través del EndPoint de la API de SmartReport

La API de SmartReport facilita la entrega de datos GPS a través de un endpoint especializado, proporcionando una integración eficiente y segura para transmitir información de ubicación en tiempo real. A continuación, se detallan las especificaciones y el proceso para configurar y utilizar esta API.

URL(producción): https://endpoint.smartreport.cl/api/sendPositions/proveedorGPS/cliente/

o   Donde proveedorGPS es el nombre de la empresa que transmitirá la data GPS (todo en minúsculas).

o   Donde cliente es el nombre del cliente al cual pertenece la data (Ejemplo: hertz, national, avis, etc…).

• URL (testing): https://testpoint.smartreport.cl/api/sendPositions/proveedorGPS/cliente/

• Para ambos casos se usa Método: POST.

• Headers: Content-Type: application/json

• Enviar data de posiciones a través del body en formato JSON (ver a continuación):

[
  {
    "position": {
      "gps": {
        "alt": 121,
        "lat": -35.432207,
        "lon": -71.626843,
        "nsat": 11,
        "speed": 0,
        "rumbo": 30,
        "fecha": "2021-09-26T10:38:51Z",
        "evento": "Encendido de motor"
      },
      "vehiculo": {
        "patente": "ABCD-01",
        "descripcion": "Hyundai – Elantra - 2019"
      }
    }
  },
  ...
]

* Se pueden enviar 1 o varias posiciones al mismo tiempo.

            Descripción de los campos solicitados:

• "alt" =  Altitud

• "lat" = Latitud

• "lon" = Longitud

• "nsat" = Número de Satélites enlazados.

• "speed" = Velocidad

• “rumbo” = Rumbo o dirección en grados que lleva el vehiculo

• "fecha" = Fecha de la posición GPS en formato UTC

• “evento” = Evento o descripción de la posición enviada

• "patente" = Patente del Vehículo

• “descripcion” = Descripcion del vehículo

·      Respuestas de la API:

o   En caso de existir algún error en la petición enviada la API devuelve una respuesta JSON con valores tales como:

 [{ success: false, vehiculo: “ABCD-19”, msg: "Mensaje con breve descripción del error." }]

o   De no existir ningún error el API devuelve una respuesta tal como:

 [{ success: true, vehiculo: “ABCD-19”, msg: 'Posición registrada.' }]

Una vez analicen la factibilidad de ajustar su API (webservice) para transmitir a nuestro EndPoint notificarnos para habilitar acceso al mismo y así puedan realizar los envíos de la data de Posiciones, de tal manera que definamos un tiempo para realizar las pruebas necesarias, el monitoreo respectivo y realizar los ajustes que sean necesarios, a fin de garantizar que la información enviada sea recibida y procesada correctamente.

            En primeras instancias se hacen las pruebas de integración en el ambiente de test (testpoint) una vez se verifique la correcta integración y que los datos transmitidos sean correctos, se puede dejar implementado el ambiente definitivo o de producción.