Sobre a API

Esta API possui endpoints privados e públicos. A API pública possui dados de latitude, longitude e a quantidade de ovos de cada município participante no tempo. A API privada é recomendada apenas para aplicativos que trabalham em parceria com o Conta Ovos devido a ela possuir dados sensíveis. Para utilizar a API privada você precisará de uma chave. Para adquirir sua chave envie um email para contaovosdengue@gmail.com com os seguintes pontos:

• Explicando por que necessita de acesso a API
• Qual o nível de acesso (municipal, regional, estadual, país)
• De qual região geográfica pertence

A chave será composta por 45 letras de forma aleatória.

Endpoints Públicos

Últimas contagens lançadas

Endpoint para verificar as últimas contagens lançadas por localização (Municipal, Estatual e País) com o número de ovos e dados da ovitrampa. Pode receber os seguintes parâmetros:

• state: pode ser informado o código do estado. Exemplo: state=RJ.
• municipality: pode ser informado o nome do município. Exemplo: municipality=Ponta Pora
• country: pode ser informado o nome do município. Exemplo: country=Brasil. Caso não indique será considerado "Brasil".
• page: a paginação que está situado. Caso não indique, será considerada a página 1. Precisa ser um número.
• id: exibe ocorrências a partir do id passado como parâmetro. Exemplo: id=7876, irá apenas exibir ids a partir de 7876
• date: exibe ocorrências a partir da data de inclusão passada como parâmetro. Exemplo: date=2025-01-01, irá apenas exibir datas a partir de 2025-01-01
• date_collect: exibe ocorrências a partir da data de alteração passada como parâmetro. Exemplo: date_collect=2024-12-12, irá apenas exibir datas a partir de 2024-12-12
• date_start: define a data inicial para filtrar as contagens. Exemplo: date_start=2025-01-01.
• date_end: define a data final para filtrar as contagens. Exemplo: date_end=2025-12-31.

curl -G -d "municipality=Ponta%20Pora" https://contaovos.com/es-pr/api/lastcountingpublic

curl -G -d "state=MG" https://contaovos.com/es-pr/api/lastcountingpublic

OBS: Caso não seja passado nenhum parâmetro, o endpoint devolverá as últimas contagens do Brasil.

Últimas ações em quarteirões

Endpoint que traz dados das ações nos quarteirões. Pode receber os seguintes parâmetros:

• state: pode ser informado o código do estado. Exemplo: state=RJ.
• municipality: pode ser informado o nome do município. Exemplo: municipality=Ponta Pora
• country: pode ser informado o nome do município. Exemplo: country=Brasil. Caso não indique será considerado "Brasil".
• page: a paginação que está situado. Caso não indique, será considerada a página 1. Precisa ser um número.

curl -G -d "municipality=Vista%20Alegre" https://contaovos.com/es-pr/api/getmunicipalityblockspublic

curl -G -d "state=MS" https://contaovos.com/es-pr/api/getmunicipalityblockspublic

Endpoints Privados

Últimas contagens lançadas

Endpoint para verificar as últimas contagens lançadas, com número de ovos e dados da ovitrampa. Precisa dos seguintes parâmetros:

• key: a sua chave da API, com ela será definido o escopo das últimas contagens (municipal, regional, estadual, país).
• page: a paginação que está situado. Caso não indique, será considerada a página 1. Precisa ser um número.
• date_start: define a data inicial para filtrar as contagens. Exemplo: date_start=2025-01-01.
• date_end: define a data final para filtrar as contagens. Exemplo: date_end=2025-12-31.

curl -G -d "key=KEY&page=1" https://contaovos.com/es-pr/api/lastcounting

Envio de Leitura

Endpoint para envio das leituras de uma ovitrampa. É possível enviar dados para uma ovitrampa já existente ou enviar os dados e instalar uma nova ovitrampa. Precisa dos parâmetros:

• key: a sua chave da API, com ela será definido o escopo das últimas contagens (municipal, regional, estadual, país).

curl -X POST -d "key=KEY" https://contaovos.com/es-pr/api/postcounting

Para o envio default, onde não é preciso instalar uma nova ovitrampa, é necessário enviar os seguintes campos (todos obrigatórios) no payload da requisição. Os tipos correspondem ao exemplo abaixo em formato form:

 { "ovitrap_group_id": 97, "ovitrap_lat": -7.000000, "ovitrap_lng": -8.000000, "date": "2025-01-20", "counting_observation_id": 1, "counting_observation": "caso o counting_observation_id seja 9", "counting_eggs": 5, } 

Abaixo segue nossa tabela com os IDs de cada tipo de observação:

Para o envio onde uma nova ovitrampa será instalada, necessário enviar os seguintes campos obrigatórios: ovitrap_lat, ovitrap_lng e ovitrap_group_id. Os tipos correspondem ao exemplo abaixo:

 { "ovitrap_group_id": 96, "ovitrap_address_district": "Distrito", "ovitrap_address_street": "Rua", "ovitrap_address_number": "Numero", "ovitrap_address_complement": "Complemento", "ovitrap_address_loc_inst": "", "ovitrap_lat": -7.000000, "ovitrap_lng": -8.000000, "ovitrap_address_sector": "Setor", "ovitrap_responsable": "Responsável", "ovitrap_block_id": "Quarteião", "date": "2025-01-20", "counting_date_collect": "2025-01-27", "counting_observation_id": 1, "counting_observation": "caso o counting_observation_id seja 9", "counting_eggs": 5 } 

Deletar Leitura

Endpoint para deletar leitura de uma ovitrampa. Precisa dos parâmetros:

• key: a sua chave da API, com ela será definido o escopo das últimas contagens (municipal, regional, estadual, país).

curl -X POST -d "key=KEY" https://contaovos.com/es-pr/api/postdeletecounting

É necessário os seguintes dados enviados em form:

 { "ovitrap_group_id": 97, "date": "2025-01-20" } 

Deletar Ovitrampa

Endpoint para deletar uma ovitrampa. Precisa dos parâmetros:

• key: a sua chave da API.

curl -X POST -d "key=KEY" https://contaovos.com/es-pr/api/postdeleteovitrap

É necessário os seguintes dados enviados em form:

 { "ovitrap_group_id": 97, } 

Inserir Visita

Para adicionar uma visita é necessário o campo block_id. Caso ele não exista, pode-se utilizar o campo block_group_id. Neste caso o sistema irá criá-lo.

Este endpoint só permite a inserção de quarteirões que estão dentro do município do solicitante.

Precisa dos parâmetros:

• key: a sua chave da API.

curl -X POST -d "key=KEY" https://contaovos.com/es-pr/api/postaction

É necessário os seguintes dados enviados em form ou query parameters com o uso do block_id:

 { "block_id": 97, "date": "2025-01-20" "block_land_residence": 10, "action_land_residence_out": 2, "action_land_residence_breedings": 1, "action_land_residence_treated": 1, "block_land_commercial": 5, "action_land_commercial_out": 0, "action_land_commercial_breedings": 0, "action_land_commercial_treated": 0, "block_land_empty": 3, "action_land_empty_out": 1, "action_land_empty_breedings": 2, "action_land_empty_treated": 1, "block_land_strategy": 1, "action_land_strategy_out": 0, "action_land_strategy_breedings": 0, "action_land_strategy_treated": 0, "block_land_special": 0, "action_land_special_out": 0, "action_land_special_breedings": 0, "action_land_special_treated": 0, "block_land_another": 2, "action_land_another_out": 0, "action_land_another_breedings": 0, "action_land_another_treated": 0, "action_deposit_a1_quantity": 4, "action_deposit_a1_eliminated": 2, "action_deposit_a1_treated": 1, "action_deposit_a1_larvicid": 10, "action_deposit_a2_quantity": 2, "action_deposit_a2_eliminated": 1, "action_deposit_a2_treated": 0, "action_deposit_a2_larvicid": 0, "action_deposit_b_quantity": 5, "action_deposit_b_eliminated": 5, "action_deposit_b_treated": 0, "action_deposit_b_larvicid": 0, "action_deposit_c_quantity": 1, "action_deposit_c_eliminated": 0, "action_deposit_c_treated": 1, "action_deposit_c_larvicid": 5, "action_deposit_d1_quantity": 0, "action_deposit_d1_eliminated": 0, "action_deposit_d1_treated": 0, "action_deposit_d1_larvicid": 0, "action_deposit_d2_quantity": 3, "action_deposit_d2_eliminated": 1, "action_deposit_d2_treated": 2, "action_deposit_d2_larvicid": 15, "action_deposit_e_quantity": 0, "action_deposit_e_eliminated": 0, "action_deposit_e_treated": 0, "action_deposit_e_larvicid": 0, "action_observation": "Visita realizada conforme cronograma. Foco encontrado em pneus nos fundos do imóvel." } 

No caso de optar pelo block_group_id, é necessário os seguintes dados enviados em form ou query parameters::

 { "block_id": 97, "date": "2025-01-20" "block_address_district": "Centro Histórico", "block_address_sector": "Setor 04 - Norte", "block_coordinates": "[[-7.123, -34.845], [-7.124, -34.846]]", "block_lat": -7.123456, "block_lng": -34.845678, "block_responsable": "João da Silva", "block_land_residence": 10, "action_land_residence_out": 2, "action_land_residence_breedings": 1, "action_land_residence_treated": 1, "block_land_commercial": 5, "action_land_commercial_out": 0, "action_land_commercial_breedings": 0, "action_land_commercial_treated": 0, "block_land_empty": 3, "action_land_empty_out": 1, "action_land_empty_breedings": 2, "action_land_empty_treated": 1, "block_land_strategy": 1, "action_land_strategy_out": 0, "action_land_strategy_breedings": 0, "action_land_strategy_treated": 0, "block_land_special": 0, "action_land_special_out": 0, "action_land_special_breedings": 0, "action_land_special_treated": 0, "block_land_another": 2, "action_land_another_out": 0, "action_land_another_breedings": 0, "action_land_another_treated": 0, "action_deposit_a1_quantity": 4, "action_deposit_a1_eliminated": 2, "action_deposit_a1_treated": 1, "action_deposit_a1_larvicid": 10, "action_deposit_a2_quantity": 2, "action_deposit_a2_eliminated": 1, "action_deposit_a2_treated": 0, "action_deposit_a2_larvicid": 0, "action_deposit_b_quantity": 5, "action_deposit_b_eliminated": 5, "action_deposit_b_treated": 0, "action_deposit_b_larvicid": 0, "action_deposit_c_quantity": 1, "action_deposit_c_eliminated": 0, "action_deposit_c_treated": 1, "action_deposit_c_larvicid": 5, "action_deposit_d1_quantity": 0, "action_deposit_d1_eliminated": 0, "action_deposit_d1_treated": 0, "action_deposit_d1_larvicid": 0, "action_deposit_d2_quantity": 3, "action_deposit_d2_eliminated": 1, "action_deposit_d2_treated": 2, "action_deposit_d2_larvicid": 15, "action_deposit_e_quantity": 0, "action_deposit_e_eliminated": 0, "action_deposit_e_treated": 0, "action_deposit_e_larvicid": 0, "action_observation": "Área com alta densidade de recipientes descartáveis." } 

Deletar Visita

Endpoint para deletar uma visita. Precisa dos parâmetros:

• key: a sua chave da API.

curl -X POST -d "key=KEY" https://contaovos.com/es-pr/api/postdeleteaction

É necessário os seguintes dados enviados em form:

 { "block_group_id": 97, "date": "2025-01-20" } 

Deletar Quarteirão

Endpoint para deletar um quarteirão. Precisa dos parâmetros:

• key: a sua chave da API.

curl -X POST -d "key=KEY" https://contaovos.com/es-pr/api/postdeleteblock

É necessário os seguintes dados enviados em form:

 { "block_group_id": 97, }