curl --request POST \
--url https://api-vendas.taximachine.com.br/api/v2/integracao/configuracoes/areas \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"nome": "Centro",
"prioridade": 3,
"poligono": {
"type": "Polygon",
"coordinates": [
[
[
-46.6558,
-23.5615
],
[
-46.65,
-23.5615
],
[
-46.65,
-23.557
],
[
-46.6558,
-23.557
],
[
-46.6558,
-23.5615
]
]
]
}
}
'{
"success": true,
"data": {
"id": 14,
"nome": "Centro",
"prioridade": 3,
"cor_linha": "#000000",
"cor_preenchimento": "#FFFF00",
"area_bloqueio": false,
"hora_bloqueio_inicio": null,
"hora_bloqueio_fim": null,
"poligono": {
"type": "Polygon",
"coordinates": [
[
[
-46.6558,
-23.5615
],
[
-46.65,
-23.5615
],
[
-46.65,
-23.557
],
[
-46.6558,
-23.557
],
[
-46.6558,
-23.5615
]
]
]
}
}
}Criar área
Cria uma área de operação da central autenticada, matriz ou filial, com o polígono em GeoJSON. É a mesma área que a tela de Áreas do painel cria, sem central associada: ela aparece em GET /configuracoes/areas-geograficas e na tela de Áreas.
A área pertence sempre à central da Api-Key. Campos fora do body documentado, como tipo, bandeira_id ou bandeira_responsavel_id, são ignorados.
O nome é único entre as áreas da central, sem diferenciar maiúsculas, minúsculas e acentos: Centro e centro são o mesmo nome. Duas criações simultâneas com o mesmo nome criam uma área só; a outra recebe 409 e pode reenviar.
O polígono aceita de 3 a 2.500 vértices distintos. Quanto mais vértices, mais lenta a gravação: um polígono perto do limite pode levar mais de um minuto.
Com area_bloqueio igual a true, a área vira área de bloqueio da central, no horário informado ou o dia todo quando o horário é omitido. Central que faz somente entregas não tem área de bloqueio.
Requer Api-Key (bandeira) + autenticação HTTP Basic de um gestor ativo da bandeira. Gestor com empresa vinculada não cria área.
curl --request POST \
--url https://api-vendas.taximachine.com.br/api/v2/integracao/configuracoes/areas \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"nome": "Centro",
"prioridade": 3,
"poligono": {
"type": "Polygon",
"coordinates": [
[
[
-46.6558,
-23.5615
],
[
-46.65,
-23.5615
],
[
-46.65,
-23.557
],
[
-46.6558,
-23.557
],
[
-46.6558,
-23.5615
]
]
]
}
}
'{
"success": true,
"data": {
"id": 14,
"nome": "Centro",
"prioridade": 3,
"cor_linha": "#000000",
"cor_preenchimento": "#FFFF00",
"area_bloqueio": false,
"hora_bloqueio_inicio": null,
"hora_bloqueio_fim": null,
"poligono": {
"type": "Polygon",
"coordinates": [
[
[
-46.6558,
-23.5615
],
[
-46.65,
-23.5615
],
[
-46.65,
-23.557
],
[
-46.6558,
-23.557
],
[
-46.6558,
-23.5615
]
]
]
}
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Obrigatório. Sua chave API.
Body
Nome da área, até 100 caracteres. Espaços nas pontas são removidos.
100"Centro"
Prioridade da área, de 1 a 5.
1 <= x <= 53
Polígono GeoJSON (RFC 7946) com um único anel.
Show child attributes
Show child attributes
Cor da borda no mapa, no formato #RRGGBB. Quando omitida, vale #000000.
^#[0-9A-Fa-f]{6}$"#1E88E5"
Cor do preenchimento no mapa, no formato #RRGGBB. Quando omitida, vale #FFFF00.
^#[0-9A-Fa-f]{6}$"#90CAF9"
Informe true para tornar a área uma área de bloqueio da central.
true
Início do bloqueio, no formato HH:mm. Só vale com area_bloqueio igual a true, e junto com hora_bloqueio_fim.
^([01][0-9]|2[0-3]):[0-5][0-9]$"22:00"
Fim do bloqueio, no formato HH:mm, diferente do início. Só vale com area_bloqueio igual a true, e junto com hora_bloqueio_inicio.
^([01][0-9]|2[0-3]):[0-5][0-9]$"06:00"
Response
Área criada
The response is of type object.