Просматривайте и отправляйте данные о ловушках, кварталах и посещениях мест непосредственно из вашей системы. На этой странице описаны все доступные общедоступные и частные конечные точки.
У этого API есть конечные точки общественные и частные. Публичный API возвращает данные о широте, долготе и количестве яиц для каждого участвующего муниципалитета с течением времени без необходимости аутентификации. Частный API рекомендуется использовать только для приложений, работающих в партнерстве с Conta Ovos, поскольку он предоставляет конфиденциальные данные и позволяет вставлять, изменять и удалять записи.
Аутентификация и ключи
Для использования частного API вам понадобится ключ доступа (key). Чтобы приобрести его, отправьте письмо на адрес contaovosdengue@gmail.com заявив:
Зачем вам нужен доступ к API;
Какой уровень доступа требуется (муниципальный, региональный, штатный или национальный);
Частью какого географического региона вы являетесь?
Ключ состоит из 45 случайных букв и должен быть отправлен в параметре key каждого частного запроса. Географический охват и план, связанные с ключевыми (api_access_municipality_id, state_id, region_id, country_id, plan) автоматически определяет, какие записи он может читать или изменять — например, муниципальный ключ может читать или изменять данные только самого муниципалитета.
Куда отправить ключ: a key всегда читается из строки запроса URL (?key=SUA_CHAVE), включая конечные точки POST. Отправка его только в теле формы приводит к 404 "Wrong key". Остальные поля POST продолжают появляться в теле запроса.
Пагинация: параметры page примите максимум 100 на конечных точках, поддерживающих пейджинг. Неверные или отсутствующие значения занимают страницу 1.
Коды ответа
Все конечные точки следуют одному и тому же шаблону состояния HTTP:
Код
Значение
200
Запрос успешно обработан.
400
Обязательный параметр отсутствует или имеет неверный формат.
403
Сообщаемый ресурс не принадлежит области действия (город/штат/регион) используемого ключа.
404
Неверный ключ (Wrong key) или ресурс не найден.
409
Запись для этой комбинации идентификатора, года и недели уже существует.
500
Внутренняя ошибка при обработке запроса.
Публичные конечные точки
GET/api/lastcountingpublicОбщественный
Количество последних выпущенных
Возвращает последние данные по местоположению (город, штат или страна), а также количество яиц и данные о яйцеловках.
Параметры
Имя
Тип
Описание
state
string
Код штата. Пример: state=RJ.
municipality
string
Название муниципалитета. Пример: municipality=Ponta Pora
country
string
Название страны. Пример: country=Brasil. Если опущено, предполагается «Бразилия».
page
int
Страница нумерации страниц (по умолчанию 1, максимум 100).
id
int
Отображает только вхождения с заданным идентификатором. Пример: id=7876.
date
date
Отображает события с даты включения. Пример: date=2025-01-01.
date_collect
date
Отображает события, начиная с даты сбора данных. Пример: date_collect=2024-12-12.
date_start
date
Дата начала для фильтрации счетчиков. Пример: date_start=2025-01-01.
date_end
date
Дата окончания для фильтрации количества. Пример: date_end=2025-12-31.
Примечание: Если параметры местоположения не отправляются, конечная точка возвращает последние данные из Бразилии.
Конкретные ответы:
400 — когда какая-либо из отправленных дат не соответствует формату YYYY-MM-DD. В ответ выводится список недопустимых полей в invalid_fields.
Возвращает зарегистрированные в муниципалитете кварталы — по одной строке на квартал с указанием полигона, общего количества объектов недвижимости по типам и среднего количества долей.
Новая конечная точка. Если вы ищете посещения, выполненные кварталами, используйте /api/getmunicipalityblocksvisitpublic. Поскольку это общедоступная конечная точка, ответ не включает агента, ответственного за квартал, или идентификаторы пользователя/команды.
Параметры
Имя
Тип
Описание
state
string
Код штата. Пример: state=RJ.
municipality
string
Название муниципалитета. Пример: municipality=Ponta Pora
country
string
Название страны. Пример: country=Brasil. Если опущено, предполагается «Бразилия».
page
int
Страница нумерации страниц (по умолчанию 1, максимум 100).
Возвращает данные о техническом обслуживании, выполненном на EDL, включая наблюдения, записанные во время каждого обслуживания.
Заменяет/api/getmunicipalityedlvisitspublic. EDL получают обслуживание, а не посещения — поля ушли из edl_visit_* к edl_maintenance_*. Старый URL продолжает работать и продолжает возвращать старые имена, чтобы не нарушать интеграцию в продакшене, но он прекращен.
Параметры
Имя
Тип
Описание
state
string
Код штата. Пример: state=RJ.
municipality
string
Название муниципалитета. Пример: municipality=Ponta Pora
country
string
Название страны. Пример: country=Brasil. Если опущено, предполагается «Бразилия».
page
int
Страница нумерации страниц (по умолчанию 1, максимум 100).
Возвращает данные из EDL (стратегических точек, периодически посещаемых агентами) в пределах географической области действия ключа. Объем автоматически определяется планом, связанным с ключом — муниципальным, региональным, штатным или страновым — и нет необходимости информировать муниципалитет, штат или страну в запросе.
Параметры
Имя
Тип
Описание
key
string
Ваш API-ключ. Определяет географический охват возвращаемых EDL.
page
int
Страница нумерации страниц (по умолчанию 1, максимум 100).
Внимание: поля ответа от этой частной конечной точки продолжаются с префиксом edl_visit_*. Только эквивалентная общедоступная конечная точка начала использовать edl_maintenance_*.
Возвращает данные о посещениях EDL в пределах географического охвата ключа, включая наблюдения, записанные при каждом посещении. Объем автоматически определяется планом, связанным с ключом — муниципальным, региональным, штатным или страновым — и нет необходимости информировать муниципалитет, штат или страну в запросе.
Параметры
Имя
Тип
Описание
key
string
Ваш API-ключ. Определяет географический охват повторных посещений.
page
int
Страница нумерации страниц (по умолчанию 1, максимум 100).
Возвращает данные о действиях (лечебных посещениях), выполненных в кварталах в пределах географического охвата ключа. Объем автоматически определяется планом, связанным с ключом — муниципальным, региональным, штатным или страновым — и нет необходимости информировать муниципалитет, штат или страну в запросе.
Параметры
Имя
Тип
Описание
key
string
Ваш API-ключ. Определяет географический охват возвращаемых действий.
page
int
Страница нумерации страниц (по умолчанию 1, максимум 100).
Возвращает данные из яйцеловок (точек мониторинга яиц) в пределах географической области действия ключа. Объем автоматически определяется планом, связанным с ключом — муниципальным, региональным, штатным или страновым — и нет необходимости информировать муниципалитет, штат или страну в запросе.
Возвращает объекты (стратегические точки и особые объекты) в пределах географической области ключа. Область определяется автоматически планом, связанным с ключом — муниципальный, региональный, уровня штата или страны — поэтому указывать муниципалитет, штат или страну в запросе не нужно.
Параметры
Имя
Тип
Описание
key
string
Ваш API-ключ. Определяет географический охват возвращаемых точек.
page
int
Страница нумерации страниц (по умолчанию 1, максимум 100).
Отправляет чтение яйцеловки. Можно отправить данные в существующую яйцеловку или одновременно отправить данные и установить новую яйцеловку.
Параметры
Имя
Тип
Описание
key
string
Ваш API-ключ. Определяет объем представления.
Пример запроса
curl -X POST \
"/ru-ru/api/postcounting?key=KEY"
Для стандартной доставки, при которой нет необходимости устанавливать новый яйцеловитель, отправьте следующие поля: (все обязательно) в теле запроса (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
}
Таблица с идентификаторами каждого типа наблюдения (counting_observation_id):
ID
Значение
1
Нет замечаний
2
Интервал между установкой и сбором дольше, чем ожидалось.
3
Яйцеловка или недостающая палитра
4
Яйцеловка или сломанная палитра
5
Яйцеварка или палитра удалены
6
Сухая яйцеловка
7
Закрытый дом
8
Яйцеловушка, наполненная водой
9
Яйцеловушка с небольшим количеством воды
10
Еще одно наблюдение
Чтобы установить новую яйцеловку рядом с грузом, обязательный поля: ovitrap_lat, ovitrap_lng, ovitrap_group_id
Таблица с идентификаторами каждого типа яйцеловок (ovitrap_type_id): отправить 1 в городскую яйцеловку и 2 в сельскую яйцеловку. Поле является необязательным и, если оно не отправлено, яйцеловушка устанавливается как городская:
ID
Значение
1
Городская яйцеловка (стандартный)
2
Сельская яйцеловка
Конкретные ответы:
400 — когда не отправлено ни одно из обязательных полей: ovitrap_lat, ovitrap_lng, ovitrap_group_id, date
400 — когда ovitrap_type_id отправлено не 1 и не 2.
400 — когда какая-либо из отправленных дат не соответствует формату YYYY-MM-DD. В ответ выводится список недопустимых полей в invalid_fields.
404 — Этой яйцеловке уже есть счет, год и неделя.
POST/api/postdeletecountingЧастный
Удалить чтение
Удаляет чтение из яйцеловки.
Параметры
Имя
Тип
Описание
key
string
Ваш API-ключ. Определяет объем удаления.
Пример запроса
curl -X POST \
"/ru-ru/api/postdeletecounting?key=KEY"
Данные, необходимые в теле запроса (form):
{
"ovitrap_group_id": 97,
"date": "2025-01-20"
}
Конкретные ответы:
400 — когда date не отправляется.
400 — когда какая-либо из отправленных дат не соответствует формату YYYY-MM-DD. В ответ выводится список недопустимых полей в invalid_fields.
POST/api/postdeleteovitrapЧастный
Удалить яйцеловку
Удалить яйцеловку.
Параметры
Имя
Тип
Описание
key
string
Ваш API-ключ.
Пример запроса
curl -X POST \
"/ru-ru/api/postdeleteovitrap?key=KEY"
Данные, необходимые в теле запроса (form):
{
"ovitrap_group_id": 97
}
POST/api/postactionЧастный
Вставить визит
Зарегистрируйте посещение/действие в квартале. Чтобы добавить посещение в существующий квартал, отправьте поле block_id. Если он не существует, используйте block_group_id — система автоматически создаст квартал. Эта конечная точка позволяет вставлять только те кварталы, которые находятся в пределах муниципалитета заявителя.
Параметры
Имя
Тип
Описание
key
string
Ваш API-ключ.
Пример запроса
curl -X POST \
"/ru-ru/api/postaction?key=KEY"
Данные отправлены form или параметры запроса, используя block_id: