Idioma:
  • Português
  • Español

Restriction Zone

La API Restriction Zone tiene el objetivo tiene como objetivo principal realizar gestión y creación de áreas de restricción para desvío de ruta.


Insertar nueva área de restricción

Para insertar una nueva área de restricción, realiza una solicitud de tipo POST. Será necesario tener un array con las latitudes y longitudes de cada vértice del polígono.

Ejemplo de solicitud con CURL
curl 
-H "Content-Type: application/json" 
-H "clientId: meuclientid" 
-H "Authorization: Bearer pwkgGcEWu8IcFCQZtSDfT1GvqTIb" 
-X POST "https://api.maplink.global/restriction/v1/restrictionZones" 
-d @C:/TEMP/post_restrictionzone_teste99.json

El archivo JSON debe tener el siguiente contenido:

Nueva área de restricción JSON
{
    "name": "teste99",
    "geometries": [
        {
            "name": "",
            "vertices": [
                {
                    "latitude": -23.694834,
                    "longitude": -46.777038
                },
                {
                    "latitude": -23.694834,
                    "longitude": -46.448822
                },
                {
                    "latitude": -23.472064,
                    "longitude": -46.448822
                },
                {
                    "latitude": -23.472064,
                    "longitude": -46.777038
                }
            ]
        }
    ],
    "roadMap": "BRA_201809"
}
  • «name»: «teste99» – es el nombre del área de restricción;
  • «geometries» – array de geometría que contiene el nombre y los vértices.
  • «geometries».”name” – es el nombre opcional de la geometría;
  • «geometries».»vertices» – array de vértices que contiene latitud y longitud;
  • «roadMap»: «BRA_201809» – Mapa base a procesar en el área de restricción. Consulta con Maplink para obtener el mapa base más actualizado. Debe ser el mismo que se usa en las otras API para considerar la misma base de calle.

Responses:

  • 201 – Restriction zone successfully created
  • 400 – Restricton zone with validation errors


Consultando el área de restricción

Para consultar un área de restricción se deberá realizar una solicitud GET. Deberás tener el nombre del área de restricción y el clientId.

Ejemplo de solicitud con CURL:
curl 
-H "Content-Type: application/json" 
-H "clientId: meuclientid" 
-H "Authorization: Bearer pwkgGcEWu8IcFCQZtSDfT1GvqTIb" 
-X GET "https://api.maplink.global/restriction/v1/restrictionZones/teste99"

Resultado: observa que hay un campo de “status” que indica que está listo para su uso.

Response
{
    "name": "teste99",
    "roadMap": "BRA_201809",
    "geometries": [
        {
            "name": "",
            "vertices": [
                {
                    "latitude": -23.694834,
                    "longitude": -46.777038
                },
                {
                    "latitude": -23.694834,
                    "longitude": -46.448822
                },
                {
                    "latitude": -23.472064,
                    "longitude": -46.448822
                },
                {
                    "latitude": -23.472064,
                    "longitude": -46.777038
                }
            ]
        }
    ],
    "status": {
        "name": "CALCULATED",
        "description": "Roads inside restriction zone calculated"
    }
}

Responses:

  • 200 – Restriction zone found
  • 404 – Restriction zone not found

Eliminar el área de restricción

Para eliminar un área de restricción, realiza una solicitud DELETE. Deberás tener el nombre del área de restricción y el clientId.

Exemplo da requisição com CURL:
curl
-H "Content-Type: application/json" 
-H "clientId: meuclientid" 
-H "Authorization: Bearer pwkgGcEWu8IcFCQZtSDfT1GvqTIb" 
-X DELETE "https://api.maplink.global/restriction/v1/restrictionZones/teste99"

Responses:

  • 200 – Restriction zone found
  • 404 – Restriction zone not found

Scripting con área de restricción

En este ejemplo, realizaremos la solicitud de la Trip API considerando el área de restricción. Informa el clientId en el header y el nombre del área de restricción en el cuerpo de la solicitud en «restrictionZones»:

Request API Trip
{
    "calculationMode": "THE_SHORTEST",
    "points": [
{ "latitude": -23.337132,"longitude": -46.835427,"siteId": "Cajamar"},
{"latitude": -23.682211,"longitude": -46.546867,"siteId": "SantoAndre" } 
    			],
    "profileName": "BRAZILMAINROADS",
    "restrictionZones":
    [
        "teste99"
    ],
    "startDate": 1564509260000
}
Ruta con zona restringida
Ruta sin zona de restricción

End of Content