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.
curl -X GET -d "municipality=Ponta%20Pora" https://contaovos.com/pt-br/api/lastcountingpublic
curl -X GET -d "state=MG" https://contaovos.com/pt-br/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 -X GET -d "municipality=Vista%20Alegre" https://contaovos.com/pt-br/api/getmunicipalityblockspublic
curl -X GET -d "state=MS" https://contaovos.com/pt-br/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.
curl -X GET -d "key=KEY&page=1" https://contaovos.com/pt-br/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/pt-br/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, "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:
| counting_observation_id | Significado |
|---|---|
| 1 | Sem Observações |
| 2 | Intervalo entre Instalação e coleta maior que o previsto |
| 3 | Ovitrampa ou paleta desaparecida |
| 4 | Ovitrampa ou paleta quebrada |
| 5 | Ovitrampa ou paleta removida |
| 6 | Ovitrampa seca |
| 7 | Casa fechada |
| 8 | Ovitrampa cheia de água |
| 9 | Ovitrampa com pouca água |
| 10 | Outra 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/pt-br/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/pt-br/api/postdeleteovitrap
É necessário os seguintes dados enviados em form:
{ "ovitrap_group_id": 97, }