APIについて この API にはエンドポイントがあります 公的なものと私的なもの . パブリック API は、認証を必要とせずに、参加自治体ごとに緯度、経度、卵の数に関するデータを経時的に返します。プライベート API は、機密データを公開し、レコードの挿入、変更、削除を可能にするため、Conta Ovos と連携して動作するアプリケーションにのみ推奨されます。
認証とキー プライベートAPIを使用するにはアクセスキーが必要です (key). 購入するには、次のアドレスにメールを送信してください contaovosdengue@gmail.com 述べています:
API アクセスが必要な理由。 どのレベルのアクセスが必要か (自治体、地域、州、または国)。 あなたは地理的にどの地域に属していますか? キーは次のもので構成されています 45 個のランダムな文字 パラメータで送信する必要があります key 各プライベートリクエストの。キーにリンクされた地理的範囲と計画 (api_access_municipality_id, state_id, region_id, country_id, plan) どのレコードを読み取りまたは変更できるかを自動的に定義します。たとえば、自治体キーは、自治体自体からのデータの読み取りまたは変更のみが可能です。
キーの送信先: prefira o cabeçalho Authorization: Bearer SUA_CHAVE. A query string da URL (?key=SUA_CHAVE) continua aceita em todos os endpoints, mas fica gravada em logs de servidor e proxies, e o cabeçalho não. Enviar a chave apenas no corpo do formulário resulta em 404 "Wrong key". 他の POST フィールドは引き続きリクエスト本文に表示されます。
ページネーション: パラメータ page ページングをサポートするエンドポイントでは最大 100 を受け入れます。無効な値または欠落している値は 1 ページ目になります。
レスポンスコード すべてのエンドポイントは同じ HTTP ステータス パターンに従います。
コード 意味 200 リクエストは正常に処理されました。 400 Parâmetro obrigatório ausente, em formato inválido, ou corpo da requisição ilegível. 403 通知されたリソースは、使用されたキーのスコープ (都市/州/地域) に属していません。 404 無効なキー (Wrong key ) またはリソースが見つかりません。 409 この識別子、年、週の組み合わせのレコードはすでに存在します。 500 リクエストの処理中に内部エラーが発生しました。
Como enviar o corpo de um POST Todos os endpoints POST aceitam três formatos, e você escolhe o que for mais fácil no seu sistema:
Formato Content-TypeFormulário simples application/x-www-form-urlencodedFormulário multipart multipart/form-dataJSON application/json
Não defina o cabeçalho Content-Type à mão no Postman, no Insomnia ou em bibliotecas de HTTP. Deixe a ferramenta gerá-lo: no multipart ela precisa incluir o boundary, e um Content-Type que não corresponde ao corpo faz todos os campos chegarem vazios.
Quando isso acontece a resposta é 400 com esta mensagem, e ela é sobre o envelope, não sobre os seus campos:
コピー {
"error": "Não consegui ler os campos do corpo da requisição. Envie como form-data, x-www-form-urlencoded ou JSON.",
"dica": "Se usa Postman ou Insomnia, apague o cabeçalho Content-Type e deixe a ferramenta gerá-lo sozinha."
} A chave (key) vai sempre na URL, nunca no corpo.
パブリックエンドポイント GET /api/lastcountingpublic公共
最新のリリース数 場所 (都市、州、または国) ごとに発表された最新の数を、卵子の数とオビトラップのデータとともに返します。
パラメータ 名前 タイプ 説明 statestring 州コード。例: state=RJ. municipalitystring 自治体の名前。例: municipality=Ponta Pora countrystring 国名。例: country=Brasil. 省略した場合は「ブラジル」とみなされます。 pageint ページネーション ページ (デフォルトは 1、最大 100)。 idint 指定された ID からの出現のみを表示します。例: id=7876. datedate 組み込み日以降の発生を表示します。例: date=2025-01-01. date_collectdate 収集日以降の発生を表示します。例: date_collect=2024-12-12. date_startdate カウントをフィルタリングする開始日。例: date_start=2025-01-01. date_enddate カウントをフィルタリングする終了日。例: date_end=2025-12-31.
注記: 位置パラメータが送信されない場合、エンドポイントはブラジルからの最新のカウントを返します。
具体的な回答: 400 — 送信された日付のいずれかが次の形式ではない場合 YYYY-MM-DD. 応答により、無効なフィールドのリストが返されます。 invalid_fields.リクエスト例 コピー curl -G -d "municipality=Ponta%20Pora" \
/ja-jp/api/lastcountingpublic
curl -G -d "state=MG" \
/ja-jp/api/lastcountingpublic 回答例 コピー [
{
"state_name": "Minas Gerais",
"state_code": "MG",
"municipality": "Ponta Pora",
"municipality_code": "5006606",
"eggs": 42,
"week": 3,
"year": 2025,
"time": "2025-01-20 14:32:10",
"counting_id": 118342,
"ovitrap_website_id": 981,
"ovitrap_id": "97",
"latitude": -7.000000,
"longitude": -8.000000,
"date": "2025-01-20",
"date_collect": "2025-01-27"
}
] GET /api/getmunicipalityblocksvisitpublic公共
ブロックの訪問 ブロック単位で実行された訪問 (治療アクション) に関するデータを返します。ブロックごとではなく、訪問ごとに 1 行です。
パラメータ 名前 タイプ 説明 statestring 州コード。例: state=RJ. municipalitystring 自治体の名前。例: municipality=Ponta Pora countrystring 国名。例: country=Brasil. 省略した場合は「ブラジル」とみなされます。 pageint ページネーション ページ (デフォルトは 1、最大 100)。
リクエスト例 コピー curl -G -d "municipality=Vista%20Alegre" \
/ja-jp/api/getmunicipalityblocksvisitpublic
curl -G -d "state=MS" \
/ja-jp/api/getmunicipalityblocksvisitpublic 回答例 コピー [
{
"block_id": 4521,
"block_actions_mean": 3.4,
"block_coordinates": "[[-7.123, -34.845], [-7.124, -34.846]]",
"municipality": "Vista Alegre",
"municipality_code": "5007117",
"state_name": "Mato Grosso do Sul",
"state_code": "MS",
"action_land_total_total": 21,
"action_land_residence_total": 10,
"action_land_commercial_total": 5,
"action_land_empty_total": 3,
"action_land_strategy_total": 1,
"action_land_another_total": 2,
"action_address_district": "Centro",
"action_address_sector": "Setor 04",
"action_deposit_a1_quantity": 4,
"action_deposit_a2_quantity": 2,
"action_deposit_b_quantity": 5,
"action_deposit_c_quantity": 1,
"action_deposit_d1_quantity": 0,
"action_deposit_d2_quantity": 3,
"action_deposit_e_quantity": 0,
"action_observation": "Foco encontrado em pneus nos fundos do imovel.",
"latitude": -7.123456,
"longitude": -34.845678
}
] GET /api/getmunicipalityblockspublic-2公共
登録ブロック 市区町村に登録されているブロックを返します。ブロックごとに 1 行、多角形、タイプごとのプロパティの合計、および平均シェア数が表示されます。
新しいエンドポイント。 ブロック単位で実行される訪問を探している場合は、次を使用します。 /api/getmunicipalityblocksvisitpublic. パブリック エンドポイントであるため、応答にはブロックを担当するエージェントやユーザー/チームの識別子は含まれません。
パラメータ 名前 タイプ 説明 statestring 州コード。例: state=RJ. municipalitystring 自治体の名前。例: municipality=Ponta Pora countrystring 国名。例: country=Brasil. 省略した場合は「ブラジル」とみなされます。 pageint ページネーション ページ (デフォルトは 1、最大 100)。
リクエスト例 コピー curl -G -d "municipality=Alta%20Floresta" \
/ja-jp/api/getmunicipalityblockspublic-2
curl -G -d "state=MT" \
/ja-jp/api/getmunicipalityblockspublic-2 回答例 コピー [
{
"block_id": 118342,
"block_group_id": "1",
"block_datetime": "Mon, 09 Sep 2024 10:12:41 GMT",
"latitude": -9.849042,
"longitude": -56.065069,
"block_coordinates": "[{\"lat\":-9.849042,\"lng\":-56.065069}, ...]",
"block_address_district": "DISTRITO INDUSTRIAL",
"block_address_sector": "DISTRITO INDUSTRIAL",
"block_municipality_id": 5566,
"block_active": 1,
"block_actions_mean": 22,
"block_land_total": 24,
"block_land_residence": 18,
"block_land_commercial": 4,
"block_land_empty": 2,
"block_land_strategy": 0,
"block_land_another": 0,
"municipality": "Alta Floresta",
"municipality_code": "5100250",
"state_name": "Mato Grosso",
"state_code": "MT"
}
] GET /api/getmunicipalityedlspublic公共
登録済み EDL 市区町村ごとに登録されたEDL(代理店から定期メンテナンスを受ける戦略拠点)のデータを返します。
パラメータ 名前 タイプ 説明 statestring 州コード。例: state=RJ. municipalitystring 自治体の名前。例: municipality=Ponta Pora countrystring 国名。例: country=Brasil. 省略した場合は「ブラジル」とみなされます。 pageint ページネーション ページ (デフォルトは 1、最大 100)。
リクエスト例 コピー curl -G -d "municipality=Vista%20Alegre" \
/ja-jp/api/getmunicipalityedlspublic
curl -G -d "state=MS" \
/ja-jp/api/getmunicipalityedlspublic 回答例 コピー [
{
"edl_id": 1832,
"edl_group_id": "104",
"edl_address_datetime": "2025-02-11 09:15:00",
"edl_lat": -7.123456,
"edl_lng": -34.845678,
"edl_municipality_id": 5007117,
"group_id": 12,
"user_id": 348,
"edl_responsable_agent": "João da Silva",
"edl_block_group_id": "12",
"edl_responsable_home": "Maria Souza",
"edl_date": "2025-02-11",
"edl_water_mean": 1.8,
"municipality": "Vista Alegre",
"municipality_code": "5007117",
"state_name": "Mato Grosso do Sul",
"state_code": "MS"
}
] GET /api/getmunicipalityedlmaintenancepublic公共
EDLメンテナンス 各メンテナンス中に記録された観察を含む、EDL で実行されたメンテナンスに関するデータを返します。
置き換えます /api/getmunicipalityedlvisitspublic. EDL は訪問ではなく保守を受け取ります。フィールドは以前のものから消えています。 edl_visit_* に edl_maintenance_*. 運用環境での統合が損なわれないように、古い URL は引き続き機能し、古い名前を返し続けますが、廃止されました。
パラメータ 名前 タイプ 説明 statestring 州コード。例: state=RJ. municipalitystring 自治体の名前。例: municipality=Ponta Pora countrystring 国名。例: country=Brasil. 省略した場合は「ブラジル」とみなされます。 pageint ページネーション ページ (デフォルトは 1、最大 100)。
リクエスト例 コピー curl -G -d "municipality=Vista%20Alegre" \
/ja-jp/api/getmunicipalityedlmaintenancepublic
curl -G -d "state=MS" \
/ja-jp/api/getmunicipalityedlmaintenancepublic 回答例 コピー [
{
"edl_maintenance_id": 9021,
"edl_id": 1832,
"edl_maintenance_time_week": 7,
"edl_maintenance_time_year": 2025,
"edl_maintenance_datetime": "2025-02-11 09:20:00",
"edl_maintenance_user_id": 348,
"edl_maintenance_observation": "Sem foco encontrado no local.",
"edl_maintenance_observation_id": 3,
"edl_maintenance_water_level": 0.5,
"edl_maintenance_lat": -7.123456,
"edl_maintenance_lng": -34.845678,
"edl_maintenance_municipality_id": 5007117,
"edl_maintenance_region_id": 4,
"edl_maintenance_state_id": 24,
"edl_maintenance_country_id": 1,
"edl_maintenance_date": "2025-02-11",
"edl_maintenance_observation_name": "Sem foco",
"edl_maintenance_observation_number": 3,
"municipality": "Vista Alegre",
"municipality_code": "5007117",
"state_name": "Mato Grosso do Sul",
"state_code": "MS"
}
] GET /api/getmunicipalityovitrapspublic公共
登録済みのオビトラップ 市区町村ごとに登録されたオビトラップ(卵子監視ポイント)のデータを返します。
パラメータ 名前 タイプ 説明 statestring 州コード。例: state=RJ. municipalitystring 自治体の名前。例: municipality=Ponta Pora countrystring 国名。例: country=Brasil. 省略した場合は「ブラジル」とみなされます。 pageint ページネーション ページ (デフォルトは 1、最大 100)。
リクエスト例 コピー curl -G -d "municipality=Vista%20Alegre" \
/ja-jp/api/getmunicipalityovitrapspublic
curl -G -d "state=MS" \
/ja-jp/api/getmunicipalityovitrapspublic 回答例 コピー [
{
"ovitrap_id": 4471,
"ovitrap_group_id": "97",
"ovitrap_datetime": "2025-01-20 14:32:10",
"ovitrap_lat": -7.123456,
"ovitrap_lng": -34.845678,
"ovitrap_lat_lng_error": 0,
"ovitrap_municipality_id": 5007117,
"group_id": 12,
"user_id": 348,
"ovitrap_eggs_mean": 12.5,
"ovitrap_block_id": 4521,
"municipality": "Vista Alegre",
"municipality_code": "5007117",
"state_name": "Mato Grosso do Sul",
"state_code": "MS"
}
] GET /api/getmunicipalityplacespublic公共
物件 (places) 自治体ごとに登録された物件(戦略地点および特殊物件)を返します。
パラメータ 名前 タイプ 説明 statestring 州コード。例: state=RJ. municipalitystring 自治体の名前。例: municipality=Ponta Pora countrystring 国名。例: country=Brasil. 省略した場合は「ブラジル」とみなされます。 pageint ページネーション ページ (デフォルトは 1、最大 100)。
リクエスト例 コピー curl -G -d "municipality=Vista%20Alegre" \
/ja-jp/api/getmunicipalityplacespublic
curl -G -d "state=MS" \
/ja-jp/api/getmunicipalityplacespublic 回答例 コピー [
{
"place_id": 771,
"user_id": 348,
"place_address_district": "Centro",
"place_address_sector": "Setor 04",
"place_datetime": "2025-02-05 10:00:00",
"place_address_lat": -7.123456,
"place_address_lng": -34.845678,
"place_municipality_id": 5007117,
"place_region_id": 4,
"place_state_id": 24,
"place_country_id": 1,
"place_type_id": 2,
"place_name": "Ferro-velho Bom Preço",
"place_coordinates": "[[-7.123, -34.845], [-7.124, -34.846]]",
"place_subtype": 5,
"place_area": 320.5,
"municipality": "Vista Alegre",
"municipality_code": "5007117",
"state_name": "Mato Grosso do Sul",
"state_code": "MS"
}
] プライベートエンドポイント 以下のすべてのエンドポイントにはパラメータが必要です key API キーを使用して。
GET /api/lastcountingプライベート
最新のリリース数 キーのスコープ内でリリースされた最後のカウントを、卵の数、ovitrap データ、および責任のあるユーザーとともに返します。
パラメータ 名前 タイプ 説明 keystring API キー。返されるカウントの範囲を定義します。 pageint ページネーション ページ (デフォルトは 1、最大 100)。 date_startdate カウントをフィルタリングする開始日。例: date_start=2025-01-01. date_enddate カウントをフィルタリングする終了日。例: date_end=2025-12-31.
具体的な回答: 400 — 送信された日付のいずれかが次の形式ではない場合 YYYY-MM-DD. 応答により、無効なフィールドのリストが返されます。 invalid_fields.リクエスト例 コピー curl -G -d "key=KEY&page=1" \
/ja-jp/api/lastcounting 回答例 コピー [
{
"state_name": "Minas Gerais",
"state_code": "MG",
"municipality": "Ponta Pora",
"municipality_code": "5006606",
"eggs": 42,
"week": 3,
"year": 2025,
"time": "2025-01-20 14:32:10",
"user": "Joao da Silva",
"counting_id": 118342,
"ovitrap_website_id": 981,
"ovitrap_id": "97",
"district": "Centro",
"street": "Rua das Flores",
"number": "123",
"complement": "",
"loc_inst": "",
"sector": "Setor 04",
"latitude": -7.000000,
"longitude": -8.000000,
"date": "2025-01-20",
"date_collect": "2025-01-27"
}
] GET /api/getmunicipalityedlsプライベート
登録済み EDL キーの地理的範囲内の EDL (エージェントが定期的に訪問する戦略的ポイント) からのデータを返します。範囲は、キーにリンクされた計画 (地方自治体、地域、州、または国) によって自動的に定義され、リクエストで地方自治体、州、または国を通知する必要はありません。
パラメータ 名前 タイプ 説明 keystring API キー。返される EDL の地理的範囲を定義します。 pageint ページネーション ページ (デフォルトは 1、最大 100)。
リクエスト例 コピー curl -G -d "key=KEY&page=1" \
/ja-jp/api/getmunicipalityedls 回答例 コピー [
{
"edl_id": 1832,
"edl_group_id": "104",
"edl_address_datetime": "2025-02-11 09:15:00",
"edl_lat": -7.123456,
"edl_lng": -34.845678,
"edl_municipality_id": 5007117,
"group_id": 12,
"user_id": 348,
"edl_responsable_agent": "João da Silva",
"edl_block_group_id": "12",
"edl_responsable_home": "Maria Souza",
"edl_date": "2025-02-11",
"edl_water_mean": 1.8,
"municipality": "Vista Alegre",
"municipality_code": "5007117",
"state_name": "Mato Grosso do Sul",
"state_code": "MS"
}
] GET /api/getmunicipalityedlvisitsプライベート
EDLメンテナンス 注意: このプライベート エンドポイントからの応答フィールドにはプレフィックスが続きます。 edl_visit_*. 同等のパブリック エンドポイントのみが使用を開始しました edl_maintenance_*.
各訪問で記録された観察を含む、キーの地理的範囲内の EDL への訪問に関するデータを返します。範囲は、キーにリンクされた計画 (地方自治体、地域、州、または国) によって自動的に定義され、リクエストで地方自治体、州、または国を通知する必要はありません。
パラメータ 名前 タイプ 説明 keystring API キー。返される訪問の地理的範囲を定義します。 pageint ページネーション ページ (デフォルトは 1、最大 100)。
リクエスト例 コピー curl -G -d "key=KEY&page=1" \
/ja-jp/api/getmunicipalityedlvisits 回答例 コピー [
{
"edl_visit_id": 9021,
"edl_id": 1832,
"edl_visit_time_week": 7,
"edl_visit_time_year": 2025,
"edl_visit_datetime": "2025-02-11 09:20:00",
"edl_visit_user_id": 348,
"edl_visit_observation": "Sem foco encontrado no local.",
"edl_visit_observation_id": 3,
"edl_visit_water_level": 0.5,
"edl_visit_lat": -7.123456,
"edl_visit_lng": -34.845678,
"edl_visit_municipality_id": 5007117,
"edl_visit_region_id": 4,
"edl_visit_state_id": 24,
"edl_visit_country_id": 1,
"edl_visit_date": "2025-02-11",
"edl_visit_observation_name": "Sem foco",
"edl_visit_observation_number": 3,
"municipality": "Vista Alegre",
"municipality_code": "5007117",
"state_name": "Mato Grosso do Sul",
"state_code": "MS"
}
] GET /api/getmunicipalityblocksプライベート
Visitas em quarteirões キーの地理的範囲内のブロックで実行されたアクション (治療訪問) に関するデータを返します。範囲は、キーにリンクされた計画 (地方自治体、地域、州、または国) によって自動的に定義され、リクエストで地方自治体、州、または国を通知する必要はありません。
パラメータ 名前 タイプ 説明 keystring API キー。返されるアクションの地理的範囲を定義します。 pageint ページネーション ページ (デフォルトは 1、最大 100)。
リクエスト例 コピー curl -G -d "key=KEY&page=1" \
/ja-jp/api/getmunicipalityblocks 回答例 コピー [
{
"block_id": 4521,
"block_actions_mean": 3.4,
"block_coordinates": "[[-7.123, -34.845], [-7.124, -34.846]]",
"municipality": "Vista Alegre",
"municipality_code": "5007117",
"state_name": "Mato Grosso do Sul",
"state_code": "MS",
"action_land_total_total": 21,
"action_land_residence_total": 10,
"action_land_commercial_total": 5,
"action_land_empty_total": 3,
"action_land_strategy_total": 1,
"action_land_another_total": 2,
"action_address_district": "Centro",
"action_address_sector": "Setor 04",
"action_deposit_a1_quantity": 4,
"action_deposit_a2_quantity": 2,
"action_deposit_b_quantity": 5,
"action_deposit_c_quantity": 1,
"action_deposit_d1_quantity": 0,
"action_deposit_d2_quantity": 3,
"action_deposit_e_quantity": 0,
"action_observation": "Foco encontrado em pneus nos fundos do imovel.",
"latitude": -7.123456,
"longitude": -34.845678
}
] GET /api/getmunicipalityovitrapsプライベート
登録済みのオビトラップ キーの地理的範囲内のオビトラップ (卵監視ポイント) からのデータを返します。範囲は、キーにリンクされた計画 (地方自治体、地域、州、または国) によって自動的に定義され、リクエストで地方自治体、州、または国を通知する必要はありません。
パラメータ 名前 タイプ 説明 keystring API キー。返されたオビトラップの地理的範囲を設定します。 pageint ページネーション ページ (デフォルトは 1、最大 100)。
リクエスト例 コピー curl -G -d "key=KEY&page=1" \
/ja-jp/api/getmunicipalityovitraps 回答例 コピー [
{
"ovitrap_id": 4471,
"ovitrap_group_id": "97",
"ovitrap_datetime": "2025-01-20 14:32:10",
"ovitrap_lat": -7.123456,
"ovitrap_lng": -34.845678,
"ovitrap_lat_lng_error": 0,
"ovitrap_municipality_id": 5007117,
"group_id": 12,
"user_id": 348,
"ovitrap_eggs_mean": 12.5,
"ovitrap_block_id": 4521,
"municipality": "Vista Alegre",
"municipality_code": "5007117",
"state_name": "Mato Grosso do Sul",
"state_code": "MS"
}
] GET /api/getmunicipalityplacesプライベート
物件 (places) キーの地理的範囲内の物件(戦略地点および特殊物件)を返します。範囲はキーに紐づくプラン(市、地域、州、国)によって自動的に決まるため、リクエストで自治体・州・国を指定する必要はありません。
パラメータ 名前 タイプ 説明 keystring API キー。返されるポイントの地理的範囲を定義します。 pageint ページネーション ページ (デフォルトは 1、最大 100)。
リクエスト例 コピー curl -G -d "key=KEY&page=1" \
/ja-jp/api/getmunicipalityplaces 回答例 コピー [
{
"place_id": 771,
"user_id": 348,
"place_address_district": "Centro",
"place_address_sector": "Setor 04",
"place_datetime": "2025-02-05 10:00:00",
"place_address_lat": -7.123456,
"place_address_lng": -34.845678,
"place_municipality_id": 5007117,
"place_region_id": 4,
"place_state_id": 24,
"place_country_id": 1,
"place_type_id": 2,
"place_name": "Ferro-velho Bom Preço",
"place_coordinates": "[[-7.123, -34.845], [-7.124, -34.846]]",
"place_subtype": 5,
"place_area": 320.5,
"municipality": "Vista Alegre",
"municipality_code": "5007117",
"state_name": "Mato Grosso do Sul",
"state_code": "MS"
}
] POST /api/postcountingプライベート
提出物を読む オビトラップの測定値を送信します。既存の ovitrap にデータを送信することも、データの送信と新しい ovitrap のインストールを同時に行うことも可能です。
パラメータ 名前 タイプ 説明 keystring API キー。提出の範囲を定義します。
リクエスト例 コピー curl -X POST \
"/ja-jp/api/postcounting?key=KEY" O corpo pode ir como form-data, x-www-form-urlencoded ou JSON — veja Como enviar o corpo de um POST .
新しいオビトラップを取り付ける必要がない標準配送の場合は、次のフィールドを送信してください。 (すべて必須 ) リクエストの本文で (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
} 各観測タイプの ID を含むテーブル (counting_observation_id):
ID 意味 1 観察なし 2 インストールと収集の間の間隔が予想よりも長い 3 オビトラップまたは不足しているパレット 4 オビトラップまたは壊れたパレット 5 オビトラップまたはパレットが削除されました 6 乾燥オビトラップ 7 閉ざされた家 8 水で満たされたオビトラップ 9 少量の水でオビトラップ 10 別の観察
新しいオビトラップを荷物の隣に設置するには、 必須 フィールド: ovitrap_lat, ovitrap_lng, ovitrap_group_id
コピー {
"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": "Responsavel",
"ovitrap_block_id": "Quarteirao",
"ovitrap_type_id": 1,
"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
} 各タイプのオビトラップの ID の表 (ovitrap_type_id): 1 つを都市部のオビトラップに、2 つを地方のオビトラップに送信します。 このフィールドはオプションであり、送信されない場合、オビトラップは都市としてインストールされます。
ID 意味 1 都市型オビトラップ (標準) 2 田舎のオビトラップ
具体的な回答: 400 — 必須フィールドのいずれかが送信されない場合: ovitrap_lat, ovitrap_lng, ovitrap_group_id, date400 — quando a coordenada está fora da faixa geográfica: ovitrap_lat precisa estar entre -90 e 90, e ovitrap_lng entre -180 e 180. O erro mais comum é o ponto decimal se perder na formatação do número — enviar -23374059 no lugar de -23.374059. A resposta traz os valores recebidos em ovitrap_lat e ovitrap_lng.400 — いつ ovitrap_type_id 送信された値は 1 でも 2 でもありません。400 — 送信された日付のいずれかが次の形式ではない場合 YYYY-MM-DD. 応答により、無効なフィールドのリストが返されます。 invalid_fields.404 — このオビトラップには、年と週のカウントがすでにあります。POST /api/postdeletecountingプライベート
読み取り値の削除 オビトラップからの読み取りを削除します。
パラメータ 名前 タイプ 説明 keystring API キー。削除の範囲を定義します。
リクエスト例 コピー curl -X POST \
"/ja-jp/api/postdeletecounting?key=KEY" リクエスト本文に必要なデータ (form-data, x-www-form-urlencoded ou JSON):
コピー {
"ovitrap_group_id": 97,
"date": "2025-01-20"
} 具体的な回答: 400 — いつ date は送信されません。400 — 送信された日付のいずれかが次の形式ではない場合 YYYY-MM-DD. 応答により、無効なフィールドのリストが返されます。 invalid_fields.POST /api/postdeleteovitrapプライベート
オビトラップの削除 オビトラップを取り外します。
パラメータ リクエスト例 コピー curl -X POST \
"/ja-jp/api/postdeleteovitrap?key=KEY" リクエスト本文に必要なデータ (form-data, x-www-form-urlencoded ou JSON):
コピー {
"ovitrap_group_id": 97
} POST /api/postactionプライベート
訪問を挿入 Mudança de unidade em 23/09/2026: 畑 action_deposit_<grupo>_larvicid passaram a ser em GRAMA, como pede a diretriz nacional. Antes eram miligrama. Se o seu sistema envia miligrama, divida por 1.000 antes de enviar — caso contrário a quantidade chega 1.000 vezes maior. O campo aceita decimais (0,5 g vai como 0.5).
ブロックに訪問/アクションを登録します。訪問を既存のブロックに追加するには、フィールドを送信します block_id. 存在しない場合は使用します block_group_id — システムはブロックを自動的に作成します。このエンドポイントでは、申請者の自治体内にあるブロックの挿入のみが許可されます。
パラメータ リクエスト例 コピー curl -X POST \
"/ja-jp/api/postaction?key=KEY" 送信されたデータ form-data, x-www-form-urlencoded, JSON またはクエリパラメータを使用して、 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": 1.5,
"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 imovel."
} を選択する block_group_id (ブロックはまだ登録されていません)、ブロック自体のデータも送信します。
コピー {
"block_group_id": 97,
"date": "2025-01-20",
"block_address_district": "Centro Historico",
"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": "Joao 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": 1.5,
"action_deposit_e_quantity": 0,
"action_deposit_e_eliminated": 0,
"action_deposit_e_treated": 0,
"action_deposit_e_larvicid": 0,
"action_observation": "Area com alta densidade de recipientes descartaveis."
} 具体的な回答: 400 — いつ date が送信されないか、数値フィールドの 1 つが有効な数値ではない場合。400 — 送信された日付のいずれかが次の形式ではない場合 YYYY-MM-DD. 応答により、無効なフィールドのリストが返されます。 invalid_fields.400 — いつ block_group_id 新しいブロックの作成時には送信されません。400 — quando a coordenada está fora da faixa geográfica: block_lat precisa estar entre -90 e 90, e block_lng entre -180 e 180. O erro mais comum é o ponto decimal se perder na formatação do número — enviar -23374059 no lugar de -23.374059.400 — いつ block_coordinates passa de 2000 caracteres. Antes o desenho era gravado pela metade, em silêncio, e o quarteirão abria sem mapa; agora a requisição é recusada e a resposta traz o tamanho enviado em block_coordinates_length.403 — いつ block_id 通知された情報は主要な自治体に属していません。409 — そのブロック、年、週にすでに訪問がある場合。POST /api/postdeleteactionプライベート
訪問の削除 1 つのブロックから訪問を削除します。
パラメータ リクエスト例 コピー curl -X POST \
"/ja-jp/api/postdeleteaction?key=KEY" リクエスト本文に必要なデータ (form-data, x-www-form-urlencoded ou JSON):
コピー {
"block_group_id": 97,
"date": "2025-01-20"
} 具体的な回答: 400 — いつ date は送信されません。400 — 送信された日付のいずれかが次の形式ではない場合 YYYY-MM-DD. 応答により、無効なフィールドのリストが返されます。 invalid_fields.POST /api/postdeleteblockプライベート
ブロックの削除 ブロックを削除します。
パラメータ リクエスト例 コピー curl -X POST \
"/ja-jp/api/postdeleteblock?key=KEY" リクエスト本文に必要なデータ (form-data, x-www-form-urlencoded ou JSON):
コピー {
"block_group_id": 97
} POST /api/postedlプライベート
Inserir EDL Cadastra um EDL (ponto estratégico de vigilância) no município da sua chave. Reenviar o mesmo edl_group_id devolve o EDL já existente em vez de duplicar, então é seguro repetir um lote.
O município é sempre o da sua chave — não é possível enviá-lo no corpo.
Obrigatórios: edl_group_id, edl_date (AAAA-MM-DD), edl_lat e edl_lng. Os demais campos são opcionais. Devolve o edl_id.
Se você usa Postman ou Insomnia, não defina o cabeçalho Content-Type à mão: a ferramenta precisa gerá-lo sozinha. Um Content-Type que não corresponde ao corpo faz os campos chegarem vazios.
パラメータ リクエスト例 コピー curl -X POST \
"/ja-jp/api/postedl?key=KEY" リクエスト本文に必要なデータ (form-data, x-www-form-urlencoded ou JSON):
コピー {
"edl_group_id": "EDL-014",
"edl_date": "2026-09-01",
"edl_lat": -23.5505,
"edl_lng": -46.6333,
"edl_address_district": "Centro",
"edl_address_street": "Rua das Palmeiras",
"edl_address_number": "128",
"edl_address_complement": "Fundos",
"edl_address_loc_inst": "Borracharia do Zé",
"edl_address_sector": "03",
"edl_responsable_agent": "M. Souza",
"edl_responsable_home": "J. Pereira",
"edl_block_group_id": "Q-22"
} POST /api/postdeleteedlプライベート
Deletar EDL Remove um EDL do município da sua chave, pelo mesmo código que você usou para cadastrá-lo.
パラメータ リクエスト例 コピー curl -X POST \
"/ja-jp/api/postdeleteedl?key=KEY" リクエスト本文に必要なデータ (form-data, x-www-form-urlencoded ou JSON):
コピー {
"edl_group_id": "EDL-014"
} POST /api/postedlmaintenanceプライベート
Inserir manutenção de EDL Registra uma manutenção em um EDL. Um EDL aceita no máximo uma manutenção por data.
O município é sempre o da sua chave — não é possível enviá-lo no corpo.
Obrigatórios: edl_group_id e date (AAAA-MM-DD). A data não pode cair em semana epidemiológica futura. Repetir a mesma EDL e data devolve 409.
Os nomes antigos edl_visit_observation, edl_visit_observation_id e edl_visit_water_level continuam aceitos.
パラメータ リクエスト例 コピー curl -X POST \
"/ja-jp/api/postedlmaintenance?key=KEY" リクエスト本文に必要なデータ (form-data, x-www-form-urlencoded ou JSON):
コピー {
"edl_group_id": "EDL-014",
"date": "2026-09-01",
"edl_maintenance_observation": "Sem larvas, recipiente lavado",
"edl_maintenance_observation_id": 1,
"edl_maintenance_water_level": 2
} POST /api/postdeleteedlmaintenanceプライベート
Deletar manutenção de EDL Remove uma manutenção. Ela é identificada pelo EDL mais a data, que juntos são únicos — você não precisa guardar nenhum id interno.
パラメータ リクエスト例 コピー curl -X POST \
"/ja-jp/api/postdeleteedlmaintenance?key=KEY" リクエスト本文に必要なデータ (form-data, x-www-form-urlencoded ou JSON):
コピー {
"edl_group_id": "EDL-014",
"date": "2026-09-01"
} POST /api/postplaceプライベート
Inserir imóvel Cadastra um imóvel (Ponto Estratégico ou Imóvel Especial) no município da sua chave.
O município é sempre o da sua chave — não é possível enviá-lo no corpo.
Região, estado e país saem do município da chave e não são aceitos no corpo: as quatro chaves geográficas precisam concordar entre si.
Obrigatórios: place_name, place_type_id, place_subtype, place_lat e place_lng. Devolve o place_id.
パラメータ リクエスト例 コピー curl -X POST \
"/ja-jp/api/postplace?key=KEY" リクエスト本文に必要なデータ (form-data, x-www-form-urlencoded ou JSON):
コピー {
"place_name": "Ferro-velho São Jorge",
"place_type_id": 1,
"place_subtype": 3,
"place_lat": -23.5505,
"place_lng": -46.6333,
"place_address_district": "Vila Nova",
"place_address_sector": "07",
"place_area": 350
} POST /api/postdeleteplaceプライベート
Deletar imóvel Remove um imóvel do município da sua chave.
Este é o único endpoint que pede um id interno: a tabela de imóveis não tem um código definido por você, ao contrário de ovitrampa, quarteirão e EDL. O place_id vem de /api/getmunicipalityplaces.
パラメータ リクエスト例 コピー curl -X POST \
"/ja-jp/api/postdeleteplace?key=KEY" リクエスト本文に必要なデータ (form-data, x-www-form-urlencoded ou JSON):
Editar registros Os endpoints /api/postedit* editam ovitrampas, contagens, quarteirões, visitas, EDLs, manutenções e imóveis que já existem. As regras valem para todos:
Escopo: só registros do município da sua chave, como nos demais POST. Registro de outro município responde 404.Edição parcial: só muda o que você envia. Campo ausente fica como está; campo enviado vazio grava vazio (é assim que se apaga um complemento, por exemplo). Números, datas, coordenadas e códigos não aceitam vazio.Tudo ou nada: se um dos campos for inválido, nenhum é gravado e a resposta 400 diz qual e por quê.Mesmos nomes da criação: os campos têm os nomes que você já usa em /api/postcounting, /api/postaction, /api/postedlmaintenance e /api/postplace.Trocar código ou data: new_ovitrap_group_id, new_block_group_id, new_edl_group_id renomeiam; nas leituras, new_date muda a data e recalcula a semana epidemiológica. Se o novo código ou a nova data já existirem, a resposta é 409 e nada muda.Resposta: 200 com o registro como ficou. Médias, totais e semanas que dependem do registro são recalculados na mesma chamada.POST /api/posteditovitrapプライベート
オビトラップを編集する Edita o cadastro de uma ovitrampa.
Identificação do registro 名前 タイプ 説明 ovitrap_group_idstring Código da ovitrampa no município.
Campos editáveis new_ovitrap_group_idovitrap_address_district, ovitrap_address_street, ovitrap_address_number, ovitrap_address_complement, ovitrap_address_loc_inst, ovitrap_address_sectorovitrap_responsable, ovitrap_block_idovitrap_type_id — 1 urbana, 2 ruralovitrap_lat, ovitrap_lngatualizar_desde — data YYYY-MM-DD. Copia o endereço e a coordenada novos para as leituras a partir dessa data. Sem ele, as leituras antigas continuam com o endereço de quando foram feitas.A resposta traz também countings_updated: quantas leituras receberam o endereço novo.
リクエスト例 コピー curl -X POST "/ja-jp/api/posteditovitrap" \
-H "Authorization: Bearer KEY" \
-H "Content-Type: application/json" \
-d '{"ovitrap_group_id": "97", "ovitrap_address_street": "Rua das Flores", "ovitrap_lat": -23.374059, "ovitrap_lng": -46.617245, "atualizar_desde": "2026-08-01"}' 具体的な回答: 400 — algum campo tem valor inválido: nada é alterado, e a resposta lista os campos em invalid_fields e o motivo de cada um em details.400 — nenhum campo editável foi enviado.404 — o registro não existe no município da sua chave.409 — já existe uma ovitrampa com o new_ovitrap_group_id no município.POST /api/posteditcountingプライベート
Editar leitura Edita uma leitura (contagem de ovos) de uma ovitrampa.
Identificação do registro 名前 タイプ 説明 ovitrap_group_idstring Código da ovitrampa no município. datestring Data da leitura a editar (YYYY-MM-DD).
Campos editáveis counting_eggsnew_date, counting_date_collectcounting_observation, counting_observation_id (0 = sem intercorrência)Onde a armadilha estava nesta leitura: counting_address_*, counting_address_lat, counting_address_lng A média histórica de ovos da ovitrampa é recalculada.
リクエスト例 コピー curl -X POST "/ja-jp/api/posteditcounting" \
-H "Authorization: Bearer KEY" \
-H "Content-Type: application/json" \
-d '{"ovitrap_group_id": "97", "date": "2026-09-01", "counting_eggs": 42}' 具体的な回答: 400 — algum campo tem valor inválido: nada é alterado, e a resposta lista os campos em invalid_fields e o motivo de cada um em details.400 — nenhum campo editável foi enviado.404 — o registro não existe no município da sua chave.409 — já existe uma leitura desta ovitrampa na new_date.POST /api/posteditblockプライベート
編集ブロック Edita o cadastro de um quarteirão.
Identificação do registro 名前 タイプ 説明 block_group_idstring Código do quarteirão no município.
Campos editáveis new_block_group_idblock_address_district, block_address_sector, block_responsableblock_lat, block_lng, block_coordinatesImóveis existentes: block_land_residence, block_land_commercial, block_land_empty, block_land_strategy, block_land_another (o total é recalculado) atualizar_desde — data YYYY-MM-DD. Copia o endereço e a coordenada novos para as visitas a partir dessa data. Sem ele, as visitas antigas continuam com o endereço de quando foram feitas.A resposta traz também actions_updated.
リクエスト例 コピー curl -X POST "/ja-jp/api/posteditblock" \
-H "Authorization: Bearer KEY" \
-H "Content-Type: application/json" \
-d '{"block_group_id": "12-A", "block_land_residence": 38, "block_address_district": "Centro"}' 具体的な回答: 400 — algum campo tem valor inválido: nada é alterado, e a resposta lista os campos em invalid_fields e o motivo de cada um em details.400 — nenhum campo editável foi enviado.404 — o registro não existe no município da sua chave.409 — já existe um quarteirão com o new_block_group_id no município.POST /api/posteditactionプライベート
Editar visita Edita uma visita a um quarteirão.
Identificação do registro 名前 タイプ 説明 block_group_idstring Código do quarteirão no município. datestring Data da visita a editar (YYYY-MM-DD).
Campos editáveis new_dateVisitados, como em /api/postaction: block_land_residence, block_land_commercial, block_land_empty, block_land_strategy, block_land_special, block_land_another action_land_<tipo>_out, _breedings, _treatedaction_deposit_<a1|a2|b|c|d1|d2|e>_quantity, _eliminated, _treated, _larvicid (em grama, com decimais, desde 23/09/2026)action_observation, action_responsableOs totais da visita (visitados, pendentes, positivos, tratados e larvicida) e a média do quarteirão são recalculados.
リクエスト例 コピー curl -X POST "/ja-jp/api/posteditaction" \
-H "Authorization: Bearer KEY" \
-H "Content-Type: application/json" \
-d '{"block_group_id": "12-A", "date": "2026-09-01", "block_land_residence": 21, "action_deposit_b_eliminated": 3}' 具体的な回答: 400 — algum campo tem valor inválido: nada é alterado, e a resposta lista os campos em invalid_fields e o motivo de cada um em details.400 — nenhum campo editável foi enviado.404 — o registro não existe no município da sua chave.409 — já existe uma visita a este quarteirão na new_date.POST /api/posteditedlプライベート
EDLの編集 Edita o cadastro de uma EDL.
Identificação do registro 名前 タイプ 説明 edl_group_idstring Código da EDL no município.
Campos editáveis new_edl_group_idedl_address_*, edl_responsable_agent, edl_responsable_home, edl_block_group_idedl_date, edl_lat, edl_lngatualizar_desde — data YYYY-MM-DD. Copia o endereço e a coordenada novos para as manutenções a partir dessa data. Sem ele, as manutenções antigas continuam com o endereço de quando foram feitas.A resposta traz também maintenances_updated.
リクエスト例 コピー curl -X POST "/ja-jp/api/posteditedl" \
-H "Authorization: Bearer KEY" \
-H "Content-Type: application/json" \
-d '{"edl_group_id": "E-07", "edl_responsable_home": "Maria", "atualizar_desde": "2026-08-01"}' 具体的な回答: 400 — algum campo tem valor inválido: nada é alterado, e a resposta lista os campos em invalid_fields e o motivo de cada um em details.400 — nenhum campo editável foi enviado.404 — o registro não existe no município da sua chave.409 — já existe uma EDL com o new_edl_group_id no município.POST /api/posteditedlmaintenanceプライベート
Editar manutenção de EDL Edita uma manutenção de EDL.
Identificação do registro 名前 タイプ 説明 edl_group_idstring Código da EDL no município. datestring Data da manutenção a editar (YYYY-MM-DD).
Campos editáveis new_dateedl_maintenance_water_level, edl_maintenance_observation, edl_maintenance_observation_id (os nomes antigos edl_visit_* também valem)O nível médio da água da EDL é recalculado.
リクエスト例 コピー curl -X POST "/ja-jp/api/posteditedlmaintenance" \
-H "Authorization: Bearer KEY" \
-H "Content-Type: application/json" \
-d '{"edl_group_id": "E-07", "date": "2026-09-01", "edl_maintenance_water_level": 3}' 具体的な回答: 400 — algum campo tem valor inválido: nada é alterado, e a resposta lista os campos em invalid_fields e o motivo de cada um em details.400 — nenhum campo editável foi enviado.404 — o registro não existe no município da sua chave.409 — já existe uma manutenção desta EDL na new_date.POST /api/posteditplaceプライベート
物件を編集 Edita um imóvel (ponto estratégico ou imóvel especial).
Identificação do registro 名前 タイプ 説明 place_idinteger Id do imóvel, o mesmo de /api/postdeleteplace.
Campos editáveis place_nameplace_type_id, place_subtype (trocar só o tipo realinha o subtipo)place_address_district, place_address_sectorplace_lat, place_lng, place_coordinates, place_areaリクエスト例 コピー curl -X POST "/ja-jp/api/posteditplace" \
-H "Authorization: Bearer KEY" \
-H "Content-Type: application/json" \
-d '{"place_id": 142, "place_name": "Borracharia Central", "place_area": 350}' 具体的な回答: 400 — algum campo tem valor inválido: nada é alterado, e a resposta lista os campos em invalid_fields e o motivo de cada um em details.400 — nenhum campo editável foi enviado.404 — o registro não existe no município da sua chave.403 — o imóvel é de outro município.