Cercas Virtuais (Geofences)Criar Cerca Customizada

Criar Cerca Customizada

Cria uma cerca virtual (polígono ou círculo).

Requisição HTTP

MétodoCaminho (Path)
POST/api/geofence/create2

Parâmetros de Consulta (Query)

ParâmetroTipoObrigatórioDescrição
access_tokenstringtrueO token de acesso.
accountstringtrueConta de destino.
geofencenamestringtrueNome da cerca virtual.
geofencetypeinttrueTipo de cerca: 2: círculo, 3: polígono.
geofenceparameterstringtrueParâmetros das coordenadas da cerca virtual.
Círculo (tipo 2): longitude,latitude,raio (unidade: metros).
Polígono (tipo 3): longitude,latitude;longitude,latitude;.... Máximo de 1000 coordenadas. Coordenadas de latitude/longitude mantêm 6 casas decimais.
geofencespeedingstringfalseLimite de velocidade da cerca virtual. Intervalo: [10, 400]. Unidade: KM/H.
geofenceusetimesstringfalseO alerta só será acionado nos períodos configurados. Formato: HH:mm,HH:mm;HH:mm,HH:mm;.... Intervalo: [00:00, 23:59].

Exemplos

Example 1: Create a circle geofence (no speeding alert, all-day trigger)

POST https://api.brasilsatgps.com.br/api/geofence/create2?access_token={ACCESS_TOKEN}&account=demo&geofencename=geofence1&geofencetype=2&geofenceparameter=27.914489,-25.991502,1000

Example 2: Create a circle geofence with speeding alert (80 KM/H)

POST https://api.brasilsatgps.com.br/api/geofence/create2?access_token={ACCESS_TOKEN}&account=demo&geofencename=geofence2&geofencetype=2&geofenceparameter=27.914599,-25.991502,1000&geofencespeeding=80

Example 3: Create a circle geofence with speeding alert (80 KM/H) and time periods (00:00 to 06:00)

POST https://api.brasilsatgps.com.br/api/geofence/create2?access_token={ACCESS_TOKEN}&account=demo&geofencename=geofence3&geofencetype=2&geofenceparameter=27.914489,-25.991502,1000&geofencespeeding=80&geofenceusetimes=00:00,06:00

Example 4: Create a polygon geofence

POST https://api.brasilsatgps.com.br/api/geofence/create2?access_token={ACCESS_TOKEN}&account=demo&geofencename=geofence4&geofencetype=3&geofenceparameter=105.069202,-3.994672;105.077767,-4.000879;105.074495,-4.010923

Estrutura de Retorno (Schema)

Campo JSONTipo de DadoDescrição
recordObjectObjeto que contém a resposta.
record.idstringID da cerca virtual criada.

Exemplo de Resposta JSON

{
  "code": 0,
  "record": {
    "id": "1075972"
  }
}