Os locais privados são cadastrados na API do QualP, e podem ser retornados junto com a rota quando você faz uma requisição em nossa api de roteirização.
Para cadastrar um local em nossa api, é necessário utilizar a seguinte URL, através do método
POST
:
https://api.qualp.com.br/places/locations
Os parâmetros necessário são mostrados abaixo:
cpf_cnpj
: Este parâmetro é obrigatório, e diz respeito ao CPF ou CNPJ do responsável/dono do local.integration_id
: Este parâmetro é obrigatório, e diz respeito ao id (ou chave primária) do local em seu banco de dados. É através dele que você vai realizar qualquer outro tipo de operação com um local cadastrado.name
: Este parâmetro é obrigatório, e diz respeito ao nome do local a ser cadastrado.company_name
: Este parâmetro é obrigatório, e diz respeito a razão social da empresa dona do local.description
: Este parâmetro é opcional, e descreve o local a ser cadastrado.categories
: Este parâmetro é obrigatório, e informa a quais categorias o local deve ser vinculado. Deve ser enviado um array com o id de integração (integration_id) das categorias que se deseja vincular.cep
: Este parâmetro é obrigatório e informa o CEP da localização deste local.uf
: Este parâmetro é obrigatório, e informa a unidade federativa em que este local se encontra. Deve ser enviado dois caracteres, contendo a sigla do estado.city
: Este parâmetro é obrigatório, e informa a cidade onde o local se encontra.street
: Este parâmetro é obrigatório, e informa a rua onde o local se encontra.neighbourhoods
: Este parâmetro é obrigatório, e informa o bairro onde o local se encontra.complement
: Este parâmetro é opcional e informa um complemento do endereço.additional_information
: Este parâmetro é opcional e contém informações adicionais sobre o local.latitude
: Este parâmetro é obrigatório e informa a latitude referente a localização do local.longitude
: Este parâmetro é obrigatório e informa a longitude referente a localização do local.Juntamente com os locais, é possível cadastrar produtos, serviços, contatos e áreas daquele local.
Para cadastrar um produto, você deve adicionar o parâmetro products
, contendo um array
de produtos. Estes são os parâmetros necesários:
integration_id
: Este parâmetro é obrigatório e é o id ou chave primária do produto no seu banco de dados. É através dele que você pode fazer outras operações com um produto já cadastrado.name
: Este parâmetro é obrigatório e representa o nome do produto a ser cadastrado.price
: Este parâmetro é obrigatório e representa o preço do produto. São aceitos apenas valores numéricos.unit
: Este parâmetro é obrigatório e representa a unidade na qual o produto é vendido.Para cadastrar um serviço, você deve adicionar o parâmetro services
, contendo um array
de serviços oferecidos pelo local. Estes são os parâmetros necessários:
integration_id
: Este parâmetro é obrigatório e é o id ou chave primária do serviço no seu banco de dados. É através dele que você pode fazer outras operações com um serviço já cadastrado.name
: Este parâmetro é obrigatório e representa o nome do serviço a ser cadastrado.price
: Este parâmetro é obrigatório e representa o preço do produto. São aceitos apenas valores numéricos.description
: Este parâmetro é opcional e descreve o serviço que está sendo cadastrado.Para cadastrar um serviço, você deve adicionar o parâmetro contacts
, contendo um array
de contatos do local. Estes são os parâmetros necessários:
integration_id
: Este parâmetro é obrigatório e é o id ou chave primária do contato no seu banco de dados. É através dele que você pode fazer outras operações com um contato já cadastrado.name
: Este parâmetro é obrigatório e representa o nome do contato a ser cadastrado.phone
: Este parâmetro é obrigatório e informa o telefone do contato a ser cadastrado.email
: Este parâmetro é obrigatório e informa o email do contato a ser cadastrado.Para cadastrar um área de um local, você precisa enviar um array
contendo os dados de cada área a ser cadastrada. Abaixo estão os parâmetros necessários:
integration_id
: Este parâmetro é obrigatório e é o id ou chave primária da área no seu banco de dados. É através dele que você pode fazer outras operações com uma área já cadastrada.name
: Este parâmetro é obrigatório e representa o nome da área a ser cadastrada.points
: Este parâmetro é obrigatório e representa os pontos geográficos que delimitam esta área. Pode ser enviado um array contendo os pontos em objeto de latitude e longitude ou uma polilinha codificada com precisão 6.additional_information
: Este parâmetro é opcional e contém informações adicionais sobre a área a ser cadastrada.Abaixo, é mostrado um exemplo de requisição para o cadastro de um local:
{
"cpf_cnpj": "68654887095",
"integration_id": 3,
"name": "Local Teste",
"company_name": "QualP",
"description": "O melhor portal de pedátios do Brasil!",
"categories": [1],
"cep": "84030320",
"uf": "PR",
"city": "Ponta Grossa",
"street": "Rua valério ronchi",
"number": "160",
"neighbourhoods": "Uvaranas",
"complement": "Apartamento",
"location_areas": [
{
"additional_information": "Fique por 1h50min",
"name": "Area 1",
"integration_id": "1",
"points": "zzgzn@nnau~AdCgKnJlGmJrM"
},
{
"name": "Area 2",
"integration_id": 2,
"points": [
{
"lat": -25.0884457,
"lng": -50.1690796
},
{
"lat": -25.0885131,
"lng": -50.1688844
},
{
"lat": -25.0886971,
"lng": -50.1690192
},
{
"lat": -25.0885143,
"lng": -50.1692526
}
]
}
],
"latitude": -15.8772692,
"longitude": -52.314475,
"contact": [
{
"name": "João das couves",
"phone": 456,
"email": "[email protected]",
"integration_id": 1
},
{
"name": "João das couves",
"phone": 456,
"email": "[email protected]",
"integration_id": 2
},
{
"name": "João das couves",
"phone": 456,
"email": "sdfasdfsad",
"integration_id": 3
}
],
"products": [
{
"name": "Balinha",
"price": 1,
"currency": "BRL",
"unit": 1,
"integration_id": 1
},
{
"name": "Balinha",
"price": 1,
"currency": "BRL",
"unit": 1,
"integration_id": 2
}
],
"services": [
{
"name": "Banheiro",
"currency": "BRL",
"price": 1,
"integration_id": 1
}
],
"additional_information": "Estacione apenas nos lugares demarcados"
}
{
"message": "Local adicionado com sucesso!",
"data": {
"id": 1,
"user_id": 1439,
"uf_id": 16,
"uf": "PR",
"integration_id": "1",
"area_polygon": null,
"name": "Local Teste",
"cpf_cnpj": "68654887095",
"description": "O melhor portal de pedátios do Brasil!",
"cep": "84030320",
"city": "Ponta Grossa",
"street": "Rua valério ronchi",
"number": "160",
"neighbourhoods": "Uvaranas",
"complement": "Apartamento",
"latitude": "-15.8772692",
"longitude": "-52.314475",
"additional_information": "Estacione apenas nos lugares demarcados",
"deleted_at": null,
"created_at": "2020-08-05T18:54:47.000000Z",
"updated_at": "2020-08-05T18:54:47.000000Z",
"location_areas": [
{
"id": 1,
"location_id": 1,
"name": "Area 1",
"polygon": "zzgzn@nnau~AdCgKnJlGmJrM",
"integration_id": null,
"additional_information": "Fique por 1h50min",
"deleted_at": null,
"created_at": "2020-08-05T18:54:47.000000Z",
"updated_at": "2020-08-05T18:54:47.000000Z"
},
{
"id": 2,
"location_id": 1,
"name": "Area 2",
"polygon": "zzgzn@nnau~AdCgKnJlGmJrM",
"integration_id": null,
"additional_information": null,
"deleted_at": null,
"created_at": "2020-08-05T18:54:47.000000Z",
"updated_at": "2020-08-05T18:54:47.000000Z"
},
{
"id": 9,
"location_id": 1,
"name": "Area teste",
"polygon": "zzgzn@nnau~AdCgKnJlGmJrM",
"integration_id": null,
"additional_information": null,
"deleted_at": null,
"created_at": "2020-08-07T15:01:00.000000Z",
"updated_at": "2020-08-07T15:01:00.000000Z"
}
],
"categories": [
{
"user_id": 1439,
"integration_id": "3",
"name": "Categoria teste teste",
"description": null,
"deleted_at": null,
"created_at": "2020-08-06T17:42:37.000000Z",
"updated_at": "2020-08-06T17:42:37.000000Z",
"pivot": {
"location_id": 1,
"category_id": 6
}
}
],
"location_contact": [
{
"id": 1,
"location_id": 1,
"integration_id": "1",
"name": "João das couves",
"email": "[email protected]",
"phone": "456",
"deleted_at": null,
"created_at": "2020-08-05T18:54:47.000000Z",
"updated_at": "2020-08-05T18:54:47.000000Z"
},
{
"id": 2,
"location_id": 1,
"integration_id": "2",
"name": "João das couves",
"email": "[email protected]",
"phone": "456",
"deleted_at": null,
"created_at": "2020-08-05T18:54:47.000000Z",
"updated_at": "2020-08-05T18:54:47.000000Z"
},
{
"id": 3,
"location_id": 1,
"integration_id": "3",
"name": "João das couves",
"email": "[email protected]",
"phone": "456",
"deleted_at": null,
"created_at": "2020-08-05T18:54:47.000000Z",
"updated_at": "2020-08-05T18:54:47.000000Z"
}
],
"products": [
{
"id": 1,
"location_id": 1,
"integration_id": null,
"name": "Balinha",
"description": null,
"currency": "BRL",
"price": "1.00",
"unit": 1,
"deleted_at": null,
"created_at": "2020-08-05T18:54:47.000000Z",
"updated_at": "2020-08-05T18:54:47.000000Z"
},
{
"id": 2,
"location_id": 1,
"integration_id": null,
"name": "Balinha",
"description": null,
"currency": "BRL",
"price": "1.00",
"unit": 1,
"deleted_at": null,
"created_at": "2020-08-05T18:54:47.000000Z",
"updated_at": "2020-08-05T18:54:47.000000Z"
}
],
"services": [
{
"id": 1,
"location_id": 1,
"integration_id": "1",
"name": "Banheiro",
"description": null,
"price": "1.00",
"currency": "BRL",
"deleted_at": null,
"created_at": "2020-08-05T18:54:47.000000Z",
"updated_at": "2020-08-05T18:54:47.000000Z"
}
]
}
}