Consulta y envía datos de ovitrampas, bloques y visitas de campo directamente desde tu sistema. Esta página documenta todos los puntos finales públicos y privados disponibles.
Esta API tiene puntos finales público y privado. La API pública devuelve datos sobre latitud, longitud y número de huevos de cada municipio participante a lo largo del tiempo, sin necesidad de autenticación. La API privada solo se recomienda para aplicaciones que funcionan en asociación con Conta Ovos, ya que expone datos confidenciales y le permite insertar, cambiar y eliminar registros.
Autenticación y claves
Para utilizar la API privada necesitarás una clave de acceso. (key). Para adquirirlo envía un email a contaovosdengue@gmail.com indicando:
¿Por qué necesita acceso API?
Qué nivel de acceso se requiere (municipal, regional, estatal o nacional);
¿De qué región geográfica eres parte?
La clave se compone de 45 letras al azar y debe ser enviado en el parámetro key de cada solicitud privada. El alcance geográfico y el plan vinculado a la clave. (api_access_municipality_id, state_id, region_id, country_id, plan) define automáticamente qué registros puede leer o cambiar; una clave municipal, por ejemplo, solo puede leer o modificar datos del propio municipio.
Paginación: los parametros page acepte un máximo de 100 en puntos finales que admitan paginación. Los valores no válidos o faltantes toman la página 1.
Códigos de respuesta
Todos los puntos finales siguen el mismo patrón de estado HTTP:
Código
Significado
200
Solicitud procesada exitosamente.
400
Falta el parámetro obligatorio o tiene un formato no válido.
403
El recurso informado no pertenece al alcance (ciudad/estado/región) de la clave utilizada.
404
Clave no válida (Wrong key) o recurso no encontrado.
409
Ya existe un registro para esta combinación de identificador, año y semana.
500
Error interno al procesar la solicitud.
Puntos finales públicos
GET/api/lastcountingpublicPúblico
Últimos recuentos publicados
Devuelve los últimos recuentos publicados por ubicación (ciudad, estado o país), con el número de huevos y datos de ovitrampas.
Parámetros
Nombre
Tipo
Descripción
state
string
Código de estado. Ejemplo: state=RJ.
municipality
string
Nombre del municipio. Ejemplo: municipality=Ponta Pora
country
string
Nombre del país. Ejemplo: country=Brasil. Si se omite, se supone "Brasil".
page
int
Página de paginación (por defecto 1, máximo 100).
id
int
Muestra solo ocurrencias de la identificación dada. Ejemplo: id=7876.
date
date
Muestra ocurrencias desde la fecha de inclusión. Ejemplo: date=2025-01-01.
date_collect
date
Muestra ocurrencias desde la fecha de recolección en adelante. Ejemplo: date_collect=2024-12-12.
date_start
date
Fecha de inicio para filtrar los conteos. Ejemplo: date_start=2025-01-01.
date_end
date
Fecha de finalización para filtrar recuentos. Ejemplo: date_end=2025-12-31.
Nota: Si no se envían parámetros de ubicación, el punto final devuelve los recuentos más recientes de Brasil.
Envía la lectura de una ovitrampa. Es posible enviar datos a una ovitrampa existente o enviar los datos e instalar una nueva ovitrampa al mismo tiempo.
Parámetros
Nombre
Tipo
Descripción
key
string
Su clave API. Define el alcance del envío.
Ejemplo de solicitud
curl -X POST -d "key=KEY" \ /es-ve/api/postcounting
Para envío estándar, donde no es necesario instalar una ovitrampa nueva, envíe los siguientes campos (todo obligatorio) en el cuerpo de la solicitud (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}
Tabla con los ID de cada tipo de observación (counting_observation_id):
ID
Significado
1
Sin observaciones
2
Intervalo entre instalación y recogida más largo de lo esperado
3
Ovitrap o paleta faltante
4
Ovitrap o paleta rota
5
Ovitrap o paleta retirada
6
Ovitrampa seca
7
casa cerrada
8
Ovitrampa llena de agua
9
Ovitrampa con poca agua
10
Otra observación
Para instalar una nueva ovitrampa junto al envío, obligatorio los campos: ovitrap_lat, ovitrap_lng, ovitrap_group_id
400 — cuando no se envía alguno de los campos obligatorios: ovitrap_lat, ovitrap_lng, ovitrap_group_id
404 — Ya hay un recuento para esta ovitrampa, año y semana.
POST/api/postdeletecountingPrivado
Eliminar lectura
Elimina la lectura de una ovitrampa.
Parámetros
Nombre
Tipo
Descripción
key
string
Su clave API. Define el alcance de la eliminación.
Ejemplo de solicitud
curl -X POST -d "key=KEY" \ /es-ve/api/postdeletecounting
Datos requeridos en el cuerpo de la solicitud (form):
{ "ovitrap_group_id": 97, "date": "2025-01-20"}
POST/api/postdeleteovitrapPrivado
Eliminar ovitrap
Retire una ovitrampa.
Parámetros
Nombre
Tipo
Descripción
key
string
Su clave API.
Ejemplo de solicitud
curl -X POST -d "key=KEY" \ /es-ve/api/postdeleteovitrap
Datos requeridos en el cuerpo de la solicitud (form):
{ "ovitrap_group_id": 97}
POST/api/postactionPrivado
Insertar visita
Registrar una visita/acción en un bloque. Para agregar la visita a un bloque existente, envíe el campo block_id. Si no existe, utilice block_group_id — el sistema creará el bloque automáticamente. Este punto final solo permite la inserción de manzanas que se encuentren dentro del municipio del solicitante.
Parámetros
Nombre
Tipo
Descripción
key
string
Su clave API.
Ejemplo de solicitud
curl -X POST -d "key=KEY" \ /es-ve/api/postaction
Datos enviados en form o parámetros de consulta, utilizando block_id: