Manual de Integración Appi

  1. Instrucción

1.1 Codificación de parámetros

La codificación de parámetros es UTF-8 como estándar.

Consulte: http://en.wikipedia.org/wiki/UTF-8

1.2 Formato de hora

El formato de hora es la marca de tiempo UNIX.

Consulte: https://en.wikipedia.org/wiki/Unix_time

1.3 MIME HTTP

aplicación / json; juego de caracteres = UTF-8

1.4 El formato JSON de respuesta

{«código»: 0, «mensaje»: «»}

Si el código! = 0, significa que la solicitud es un error, consulte el Capítulo 3.

El mensaje es la descripción del código, o está vacío.

  1. Lista de API

2.1 Obtener token de acceso

Propósito

Obtenga el token de acceso para las otras solicitudes, cada API debe contener el token de acceso. El token de acceso es válido solo por 2 horas, actualícelo con frecuencia. Cuando obtenga un nuevo token de acceso, el antiguo será inválido automáticamente.

Tipo de solicitud

OBTENER

Parámetros

Parámetro

Tipo

Necesario

Descripción

hora

largo

cierto

La hora en que el cliente envía la solicitud.

cuenta

cuerda

cierto

Cuenta

firma

cuerda

cierto

Firma cifrada, el algoritmo es: md5 (md5 (contraseña) + tiempo), md5 usa 32 caracteres en minúsculas.

URI

/ api / autorización

Ejemplo

La contraseña = Abc @ 34590, md5 (md5 (Abc @ 34590) + 1556243443) calculará la firma del resultado = 3844afd2c3bf68f0f3f4aa0a9ee8ee6c

Entonces la solicitud es: http://api.globalgpsperu.com/api/authorization?time=1556243443&account=test&signature=3844afd2c3bf68f0f3f4aa0a9ee8ee6c

Descripción de respuesta

JSON KEY

Tipo de valor

Descripción

grabar

Objeto

 
 

token de acceso

cuerda

El token de acceso

 

expira en

largo

access_token expira el tiempo en segundos

Respuesta JSON demo

{
    «record»: {
        «access_token»: «ACCESS_TOKEN»,
        «expires_in»: 7200,
    },
    «code»: 0
}

2.2 Track

Propósito

Obtenga los últimos datos de coordenadas para el dispositivo de seguimiento.

Tipo de solicitud

OBTENER

Parámetros

Parámetro

Tipo

Necesario

Descripción

token de acceso

cuerda

cierto

El token de acceso

imeis

cuerda

cierto

Lista de IMEI de destino, separados por comas, un máximo de 100 IMEI en una solicitud.

URI

/ api / track

Ejemplo

http://api.globalgpsperu.com/api/track?access_token=ACCESS_TOKEN&imeis=358899051025339,355139000000234

Descripción de la respuesta

JSON KEY

Tipo de valor

Descripción

 

imei

cuerda

El imei del objetivo

 

Tiempo de Servidor

largo

Hora actual del servidor

 

gpstime

largo

Tiempo gps

 

corazon

largo

Hora del corazón, la última vez que el objetivo envió datos.

 

hora del sistema

largo

La hora del sistema cuando el objetivo envió gps dta.

 

longitud

doble

Longitud

 

latitud

doble

latitud

 

curso

En t

curso (Noth es 0, aumento en sentido horario, máximo 360.)

 

velocidad

En t

velocidad (KM / H)

 

acctime

largo

El estado del ACC mantuvo el intervalo de tiempo en segundos

 

accstatus

En t

Estado del ACC
1: ACC ON,
0: ACC OFF,
-1: Sin estado acc

 

estado de la puerta

En t

Estado de la puerta
1: Puerta abierta,
0: Puerta cerrada,
-1: Sin estado de la puerta

 

estado de carga

En t

Estado de carga
1:
cargando, 0: no en carga,
-1: no existe tal estado

 

Oilpowerstatus

En t

Estado de Fule,
1: suministro de combustible correcto,
0: suministro de combustible apagado,
-1: No existe tal estado

 

estado de defensa

En t

Estado de defensa
1: Defensa activada,
0: Defensa desactivada,
-1: No existe tal estado

 

estado de datos

En t

1: Nunca en línea,
2: OK,
3: Caducado,
4: Fuera de línea,
5: Bloquear

 

batería

En t

La batería
-1: sin estado de la batería

Respuesta JSON demo

{
    «record»: [
        {
        «imei»: «358899051025339»,
        «course»: 195,
        «systemtime»: 1419905754,
        «gpstime»: 1419906052,
        «speed»: 0,
        «hearttime»: 1419906952,
        «servertime»: 1420964313,
        «longitude»: 113.909813,
        «latitude»: 22.583197,
        «acctime»: 1400,
        «accstatus»: 1,
        «doorstatus»: 0,
        «chargestatus»: 0,
        «oilpowerstatus»: 1,
        «defencestatus»: 0,
        «datastatus»: 2,
        «battery»: 100
        }
    ],
    «code»: 0
}

2.3 Reproducción

Propósito

Obtenga los datos GPS del objetivo en el período de tiempo.

Tipo de solicitud

OBTENER

Parámetros

Parámetro

Tipo

Necesario

Descripción

token de acceso

cuerda

cierto

El token de acceso

imei

cuerda

cierto

IMEI del objetivo

begintime

largo

cierto

Hora de inicio

hora de finalización

largo

cierto

Hora de finalización

URI

/ api / reproducción

Ejemplo

http://api.globalgpsperu.com/api/playback?access_token=ACCESS_TOKEN&imei=358899051025339&begintime=1406746394&endtime=1407746394

Descripción de la respuesta

JSON KEY

Tipo de valor

Descripción

grabar

Cuerda

Los datos están separados por punto y coma, los datos en cada grupo son:
longitud, latitud, gpstime, velocidad, curso

Respuesta JSON demo

{
«record»: «113.97196,22.568616,1406858664,0,228;113.97196,22.56861,1406858684,0,228;113.97196,22.56861,1406858704,0,228;113.97196,22.56861,1406858724,0,228;113.97196,22.56861,1406858724,0,228;113.97196,22.56861,1406858724,0,228;113.97196,22.56861,1406858724,0,228;113.971934,22.568583,1406858780,0,61;113.971925,22.568585,1406858800,0,61»,
«code»: 0
}

Observación

Este api max devuelve 1000 registros GPS a la vez, cuando el cliente obtiene 1000 registros, el cliente tiene que solicitar los siguientes 1000 registros, en esta solicitud, el tiempo de inicio es el último gpstime del 1000º registro, hasta que el cliente obtenga los registros inferiores a 1000. Cuando obtienes los registros de menos de 1000, significa que tienes todos los registros GPS.

2.4 Crear geovalla

Propósito

Crea un geofence circular.

Tipo de solicitud

ENVIAR

Parámetros

Parámetro

Tipo

Necesario

Descripción

token de acceso

cuerda

cierto

El token de acceso

imei

cuerda

cierto

IMEI del objetivo

efencename

cuerda

cierto

El nombre de geofence

tipo de alarma

En t

cierto

Tipo de alarma (0: salida, 1: entrada, 2: entrada / salida)

longitud

doble

cierto

La longitud del centro de geofence

latitud

doble

cierto

La latitud del centro de geofence

radio

En t

cierto

Radio de geovalla (100 ~ 5000, unidad: metro)

URI

/ api / geofence / create

Ejemplo

http://api.globalgpsperu.com/api/geofence/create?access_token=ACCESS_TOKEN&imei=358899051025339&efencename=home&alarmtype=0&longitude=113.97196&latitude=22.56861&radius=300

Respuesta JSON demo

{«code»:0}

¿Cómo enviar un comando?

Primero llame al comando de envío api (2.5) para obtener la identificación del comando. luego llame al estado del comando de consulta api (2.6) en bucle hasta que el estado del comando sea 1 (Responder), intente un máximo de 30 veces, y luego consideramos que el comando es tiempo de espera.

2.5 Enviar comando

Propósito

enviar un comando al dispositivo desde el servidor.

Tipo de solicitud

ENVIAR

Parámetros

Parámetro

Tipo

Necesario

Descripción

token de acceso

cuerda

cierto

El token de acceso

imei

cuerda

cierto

IMEI del objetivo

mando

cuerda

cierto

El comando

RELÉ, 1: Detener el motor

RELÉ, 0: Restaurar motor

RESET: restablecer dispositivo

URI

/ api / command / send

Ejemplo

http://api.globalgpsperu.com/api/command/send?access_token=ACCESS_TOKEN&imei=358899051025339&command=RELAY,1

Descripción de la respuesta

JSON KEY

Tipo de valor

Descripción

grabar

Objeto

 
 

Commandid

cuerda

El id para consultar la respuesta del comando.

    

Respuesta JSON demo

{
    «record»: {
        «commandid»: «1B454»
    },
    «code»: 0
}

2.6 Respuesta del comando de consulta

Propósito

consulta la respuesta del comando.

Tipo de solicitud

ENVIAR

Parámetros

Parámetro

Tipo

Necesario

Descripción

token de acceso

cuerda

cierto

El token de acceso

Commandid

cuerda

cierto

La identificación devuelta del comando enviar

URI

/ api / command / query

Ejemplo

http://api.globalgpsperu.com/api/command/query?access_token=ACCESS_TOKEN&commandid=1B454

Descripción de la respuesta

JSON KEY

Tipo de valor

Descripción

grabar

Objeto

 
 

respuesta

cuerda

La respuesta del comando

 

estado de comando

En t

Estado del comando

1: ha recibido respuesta del dispositivo

0: no recibe respuesta del dispositivo

Respuesta JSON demo

{
    «record»: {
        «response»: «Cut off the fuel supply: Success! Speed: 2km/h.»,
        «commandstatus»: 1
    },
    «code»: 0
}

Observación

Esta consulta de API una vez cada 1 segundo, hasta 30 segundos.

2.7 Obtener información básica del dispositivo

Propósito

Obtenga la información básica de los dispositivos. (Devuelva un máximo de 500 dispositivos para cada cuenta).

Tipo de solicitud

OBTENER

Parámetros

Parámetro

Tipo

Necesario

Descripción

token de acceso

cuerda

cierto

El token de acceso

URI

/ api / device / list

Ejemplo

http://api.globalgpsperu.com/api/device/list?access_token=ACCESS_TOKEN

Descripción de la respuesta

JSON KEY

Tipo de valor

Descripción

grabar

Objeto

 
 

imei

cuerda

IMEI del objetivo

 

nombre del dispositivo

Cuerda

Nombre del dispositivo

 

tipo de dispositivo

Cuerda

Modelo de dispositivo

 

número de platina

Cuerda

Número de placa

 

tiempo en línea

largo

Dispositivo primera vez en línea

 

plataforma

largo

Tiempo de caducidad de la plataforma del dispositivo

Respuesta JSON demo

{
    «code»: 0,
    «record»: [
        {
            «imei»: «512345678901234»,
            «devicename»: «VT05S-01234»,
            «devicetype»: «VT05S»,
            «platenumber»: «TheOne»,
            «onlinetime»: 0,
            «platformduetime»: 0
        },
        {
            «imei»: «123456789123456»,
            «devicename»: «VT05S-23456»,
            «devicetype»: «VT05S»,
            «platenumber»: «»,
            «onlinetime»: 1419905754,
            «platformduetime»: 1588603848
        }
    ]
}

2.8 Obtener información de alarma del dispositivo

Propósito

Obtenga la información de la alarma del dispositivo (s) en el período de tiempo.

Tipo de solicitud

OBTENER

Parámetros

Parámetro

Tipo

Necesario

Descripción

token de acceso

cuerda

cierto

El token de acceso

imei

cuerda

cierto

Target IMEI

begintime

largo

cierto

Hora de inicio

hora de finalización

largo

cierto

Hora de finalización

URI

/ api / alarm / list

Ejemplo

http://api.globalgpsperu.com/api/alarm/list?access_token=ACCESS_TOKEN&imei=358899051025339&begintime=1406746394&endtime=1407746394

Descripción de la respuesta

JSON KEY

Tipo de valor

Descripción

grabar

Cuerda

Los datos están separados por punto y coma, los datos en cada grupo son: tipo de alarma, longitud, latitud, gpstime, hora del sistema, velocidad, curso, identificación de Geo-cerca

Respuesta JSON demo

{
    «code»: 0,
    «record»: «27,113.885888,22.580592,1541575497,1541575507,40,40,0»
}

Nota:

Esta API de retorno máximo de 100registros de alarma a la vez, cuando el cliente obtiene 100registros, el cliente tiene que solicitar los siguientes 100registros, en esta solicitud, la hora de inicio es la 100thhora del sistema del último registro, hasta que el cliente obtenga los registros menos de 100. Cuando obtienes los registros menos que 100, significa que tienes todos los registros de alarma.

Tipo de alarma

Descripción

Observación

1

sosAlarm

 

2

lowBatteryAlarm

 

3

powerDisconnectAlarm

 

4 4

vibración Alarma

 

5 5

geoFenceInAlarm

 

6 6

geoFenceOutAlarm

 

7 7

alarma

 

8

carMoveAlarm

 

9

motorOn

 

10

motor apagado

 

11

TireTemperatureAlarm

 

12

tireLeakPressureAlarm

 

13

tireLowPressureAlarm

 

14

tireHighPressureAlarm

 

15

gpsDeadZoneInAlarm

 

dieciséis

gpsDeadZoneOutAlarm

 

17

obdDtcAlarm

 

18 años

desmontar Alarma

 

19

powerOffAlarm

 

20

colisión Alarma

 

21

dropAlarm

 

22

routeAlarm

 

23

rapidAccelerationAlarm

 

24

rapidDecelerationAlarm

 

25

sharpTurnAlarm

 

26

puerta abierta

 

27

puerta cerrada

 

2.9 Bloquear una cuenta

Propósito

Bloquear una cuenta

Tipo de solicitud

ENVIAR

Parámetros

Parámetro

Tipo

Necesario

Descripción

token de acceso

cuerda

cierto

El token de acceso

cuenta

cuerda

cierto

Cuenta

URI

/ api / user / block

Ejemplo

http://api.globalgpsperu.com/api/user/block?access_token=ACCESS_TOKEN&account=demo

Respuesta JSON demo

{
    «code»: 0
}

2.10 Desbloquear una cuenta

Propósito

Desbloquear una cuenta

Tipo de solicitud

ENVIAR

Parámetros

Parámetro

Tipo

Necesario

Descripción

token de acceso

cuerda

cierto

El token de acceso

cuenta

cuerda

cierto

Cuenta

URI

/ api / user / unblock

Ejemplo

http://api.globalgpsperu.com/api/user/unblock?access_token=ACCESS_TOKEN&account=demo

Respuesta JSON demo

{
    «code»: 0
}

2.11 Obtener información de la cuenta

Propósito

Obtenga la breve información de la cuenta.

Tipo de solicitud

OBTENER

Parámetros

Parámetro

Tipo

Necesario

Descripción

token de acceso

cuerda

cierto

El token de acceso

cuenta

cuerda

cierto

Cuenta

URI

/ api / user / info

Ejemplo

http://api.globalgpsperu.com/api/user/info?access_token=ACCESS_TOKEN&account=demo

Descripción de la respuesta

JSON KEY

Tipo de valor

Descripción

grabar

Objeto

 
 

cuenta

Cuerda

Cuenta

nombre de usuario

Cuerda

Nombre de usuario

correo electrónico

Cuerda

Dirección de correo electrónico

móvil

Cuerda

Número de teléfono móvil

teléfono

Cuerda

Teléfono

tiempo de creación

largo

Crear tiempo

tipo de rol

En t

1 Distribuidor, 2 Usuario final, 3 Cuenta virtual

blockstatus

En t

0: bloque
1: desbloquear

Respuesta JSON demo

{
    «code»: 0,
    «record»: {
        «createtime»: 1562570435,
        «mobile»: «»,
        «telephone»: «»,
        «roletype»: 1,
        «account»: «demo»,
        «email»: «openapidemo@gmail.com»,
        «blockstatus»: 1,
        «username»: «openapidemo»
     }
}

 

2.12 Obtener información básica del dispositivo por IMEI

Propósito

Obtenga la información básica de los dispositivos según los IMEI. (Máximo 100 piezas en una solicitud).

Tipo de solicitud

OBTENER

Parámetros

Parámetro

Tipo

Necesario

Descripción

token de acceso

cuerda

cierto

El token de acceso

imeis

cuerda

cierto

Lista de IMEI de destino, separados por comas, un máximo de 100 IMEI en una solicitud.

URI

/ api / device / detail

Ejemplo

http://api.globalgpsperu.com/api/device/detail?access_token=ACCESS_TOKEN&imeis=358899051025339,355139000000234

Descripción de la respuesta

JSON KEY

Tipo de valor

Descripción

grabar

Objeto

 
 

imei

cuerda

IMEI del objetivo

 

nombre del dispositivo

Cuerda

Nombre del dispositivo

 

tipo de dispositivo

Cuerda

Modelo de dispositivo

 

número de platina

Cuerda

Número de placa

 

tiempo en línea

largo

Dispositivo primera vez en línea

 

plataforma

largo

Tiempo de caducidad de la plataforma del dispositivo

Respuesta JSON demo

{
    «code»: 0,
    «record»: [
        {
            «imei»: «512345678901234»,
            «devicename»: «VT05S-01234»,
            «devicetype»: «VT05S»,
            «platenumber»: «TheOne»,
            «onlinetime»: 0,
            «platformduetime»: 0
        },
        {
            «imei»: «123456789123456»,
            «devicename»: «VT05S-23456»,
            «devicetype»: «VT05S»,
            «platenumber»: «»,
            «onlinetime»: 1419905754,
            «platformduetime»: 1588603848
        }
    ]
}

  1. Código de error

Código

Descripción

Observación

10000

Error del sistema

 

10001

Solicitud desconocida

 

10002

Se terminó el tiempo para la autenticación

 

10003

Aún no inicias sesión

 

10004

error de parametro

 

10005

Falta el parámetro requerido

 

10006

El parámetro está fuera de rango.

 

10007

Permiso denegado

 

10009

La solicitud es demasiado frecuente

 

10010

El token de acceso no existe

 

10011

El token de acceso no es válido

 

10012

El token de acceso no está actualizado

 

10013

IMEI no está autorizado

 

10014

Error de hora de solicitud

 

10016

Cuenta bloqueada

 

20001

Error de cuenta o contraseña

 

20005

El objetivo no existe.

 

20017

El dispositivo está fuera de línea.

 

20018

El comando de envío falla.

 

20023

Sin datos.

 

20046

El objetivo ha expirado.

 

20048

Comando no admitido.

 

20089

El dispositivo está bloqueado.