Consultez et envoyez les données d'ovitrap, de blocage et de visite sur le terrain directement depuis votre système. Cette page documente tous les points de terminaison publics et privés disponibles.
Cette API a des points de terminaison public et privé. L'API publique renvoie des données sur la latitude, la longitude et le nombre d'œufs pour chaque commune participante au fil du temps, sans nécessiter d'authentification. L'API privée n'est recommandée que pour les applications qui fonctionnent en partenariat avec Conta Ovos, car elle expose des données sensibles et vous permet d'insérer, de modifier et de supprimer des enregistrements.
Authentification et clés
Pour utiliser l'API privée, vous aurez besoin d'une clé d'accès (key). Pour l'acheter, envoyez un email à contaovosdengue@gmail.com déclarant :
Pourquoi avez-vous besoin d'un accès API ?
Quel niveau d'accès est requis (municipal, régional, étatique ou national) ;
De quelle région géographique faites-vous partie ?
La clé est composée de 45 lettres aléatoires et doit être envoyé en paramètre key de chaque demande privée. Le périmètre géographique et le plan lié à la clé (api_access_municipality_id, state_id, region_id, country_id, plan) définir automatiquement les enregistrements qu'elle peut lire ou modifier — une clé municipale, par exemple, ne peut lire ou modifier que les données de la municipalité elle-même.
Pagination: les paramètres page acceptez un maximum de 100 sur les points de terminaison prenant en charge la pagination. Les valeurs invalides ou manquantes prennent la page 1.
Codes de réponse
Tous les points de terminaison suivent le même modèle d'état HTTP :
Code
Signification
200
Demande traitée avec succès.
400
Paramètre obligatoire manquant ou dans un format invalide.
403
La ressource renseignée n'appartient pas au périmètre (ville/état/région) de la clé utilisée.
404
Clé invalide (Wrong key) ou ressource introuvable.
409
Un enregistrement existe déjà pour cette combinaison identifiant, année et semaine.
500
Erreur interne lors du traitement de la demande.
Points de terminaison publics
GET/api/lastcountingpublicPublique
Derniers décomptes publiés
Renvoie les derniers décomptes publiés par emplacement (ville, état ou pays), avec le nombre d'œufs et les données sur les ovitraps.
Paramètres
Nom
Taper
Description
state
string
Code d'état. Exemple: state=RJ.
municipality
string
Nom de la commune. Exemple: municipality=Ponta Pora
country
string
Nom du pays. Exemple: country=Brasil. En cas d'omission, cela implique "Brésil".
page
int
Page de pagination (par défaut 1, maximum 100).
id
int
Affiche uniquement les occurrences de l'identifiant donné. Exemple: id=7876.
date
date
Affiche les occurrences à partir de la date d'inclusion. Exemple: date=2025-01-01.
date_collect
date
Affiche les occurrences à partir de la date de collecte. Exemple: date_collect=2024-12-12.
date_start
date
Date de début pour filtrer les décomptes. Exemple: date_start=2025-01-01.
date_end
date
Date de fin pour filtrer les décomptes. Exemple: date_end=2025-12-31.
Note: Si aucun paramètre de localisation n'est envoyé, le point de terminaison renvoie les derniers décomptes du Brésil.
Envoie la lecture d'un ovitrap. Il est possible d'envoyer des données à un ovitrap existant ou d'envoyer les données et d'installer un nouvel ovitrap en même temps.
Paramètres
Nom
Taper
Description
key
string
Votre clé API. Définit la portée de la soumission.
Exemple de demande
curl -X POST -d "key=KEY" \ /fr-fr/api/postcounting
Pour une expédition standard, où il n'est pas nécessaire d'installer un nouvel ovitrap, envoyez les champs suivants (tout est obligatoire) dans le corps de la demande (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}
Tableau avec les identifiants de chaque type d'observation (counting_observation_id):
ID
Signification
1
Aucune observation
2
Intervalle entre l'installation et la collecte plus long que prévu
3
Ovitrap ou palette manquante
4
Ovitrap ou palette cassée
5
Ovitrap ou palette retirée
6
Ovitrap sec
7
Maison fermée
8
Ovitrap rempli d'eau
9
Ovitrap avec peu d'eau
10
Une autre observation
Pour installer un nouvel ovitrap à côté de l'envoi, obligatoire les champs : ovitrap_lat, ovitrap_lng, ovitrap_group_id
400 — lorsqu'un des champs obligatoires n'est pas envoyé : ovitrap_lat, ovitrap_lng, ovitrap_group_id
404 — Il existe déjà un décompte pour cet ovitrap, année et semaine.
POST/api/postdeletecountingPrivé
Supprimer la lecture
Supprime la lecture d'un ovitrap.
Paramètres
Nom
Taper
Description
key
string
Votre clé API. Définit la portée de la suppression.
Exemple de demande
curl -X POST -d "key=KEY" \ /fr-fr/api/postdeletecounting
Données requises dans le corps de la demande (form):
{ "ovitrap_group_id": 97, "date": "2025-01-20"}
POST/api/postdeleteovitrapPrivé
Supprimer l'ovitrap
Retirez un ovitrap.
Paramètres
Nom
Taper
Description
key
string
Votre clé API.
Exemple de demande
curl -X POST -d "key=KEY" \ /fr-fr/api/postdeleteovitrap
Données requises dans le corps de la demande (form):
{ "ovitrap_group_id": 97}
POST/api/postactionPrivé
Insérer une visite
Enregistrez une visite/action dans un bloc. Pour ajouter la visite à un bloc existant, envoyez le champ block_id. S'il n'existe pas, utilisez block_group_id — le système créera automatiquement le bloc. Ce point de terminaison permet uniquement l'insertion de blocs situés dans la municipalité du demandeur.
Paramètres
Nom
Taper
Description
key
string
Votre clé API.
Exemple de demande
curl -X POST -d "key=KEY" \ /fr-fr/api/postaction
Données envoyées form ou des paramètres de requête, en utilisant block_id: