العد التلقائي مع Conta Ovos

حول واجهة برمجة التطبيقات

تحتوي واجهة برمجة التطبيقات هذه على نقاط نهاية العامة والخاصة. تقوم واجهة برمجة التطبيقات العامة بإرجاع بيانات حول خطوط الطول والعرض وعدد البيض لكل بلدية مشاركة مع مرور الوقت، دون الحاجة إلى المصادقة. يوصى باستخدام واجهة برمجة التطبيقات الخاصة فقط للتطبيقات التي تعمل بالشراكة مع Conta Ovos، لأنها تكشف عن بيانات حساسة وتسمح لك بإدراج السجلات وتغييرها وإزالتها.

المصادقة والمفاتيح

لاستخدام واجهة برمجة التطبيقات الخاصة، ستحتاج إلى مفتاح وصول (key). لشرائه، أرسل بريدًا إلكترونيًا إلى contaovosdengue@gmail.com تفيد:

لماذا تحتاج إلى الوصول إلى واجهة برمجة التطبيقات؟
ما هو مستوى الوصول المطلوب (البلدية أو الإقليمية أو الولاية أو الدولة)؛
ما هي المنطقة الجغرافية التي تنتمي إليها؟

المفتاح مكون من 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	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-Type`
Formulário simples	`application/x-www-form-urlencoded`
Formulário multipart	`multipart/form-data`
JSON	`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عام

أحدث التهم الصادرة

إرجاع أحدث التعدادات الصادرة حسب الموقع (المدينة أو الولاية أو البلد)، مع عدد البيض وبيانات مصيدة البيض.

حدود

اسم	يكتب	وصف
`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.

طلب مثال

curl -G -d "municipality=Ponta%20Pora" \
  /ar-sa/api/lastcountingpublic

curl -G -d "state=MG" \
  /ar-sa/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عام

زيارات في الكتل

إرجاع بيانات عن الزيارات (إجراءات العلاج) التي تم تنفيذها في كتل - سطر واحد لكل زيارة، وليس لكل كتلة.

حدود

اسم	يكتب	وصف
`state`	string	رمز الدولة. مثال: `state=RJ`.
`municipality`	string	اسم البلدية. مثال: `municipality=Ponta Pora`
`country`	string	اسم البلد. مثال: `country=Brasil`. إذا تم حذفه، يفترض "البرازيل".
`page`	int	صفحة ترقيم الصفحات (الافتراضي 1، والحد الأقصى 100).

طلب مثال

curl -G -d "municipality=Vista%20Alegre" \
  /ar-sa/api/getmunicipalityblocksvisitpublic

curl -G -d "state=MS" \
  /ar-sa/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عام

الكتل المسجلة

إرجاع الكتل المسجلة في البلدية - سطر واحد لكل كتلة، مع المضلع وإجمالي العقارات حسب النوع ومتوسط عدد المشاركات.

نقطة نهاية جديدة. إذا كنت تبحث عن الزيارات التي تتم في كتل، فاستخدم /api/getmunicipalityblocksvisitpublic. نظرًا لأنها نقطة نهاية عامة، فإن الاستجابة لا تتضمن الوكيل المسؤول عن الكتلة أو معرفات المستخدم/الفريق.

حدود

اسم	يكتب	وصف
`state`	string	رمز الدولة. مثال: `state=RJ`.
`municipality`	string	اسم البلدية. مثال: `municipality=Ponta Pora`
`country`	string	اسم البلد. مثال: `country=Brasil`. إذا تم حذفه، يفترض "البرازيل".
`page`	int	صفحة ترقيم الصفحات (الافتراضي 1، والحد الأقصى 100).

طلب مثال

curl -G -d "municipality=Alta%20Floresta" \
  /ar-sa/api/getmunicipalityblockspublic-2

curl -G -d "state=MT" \
  /ar-sa/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 المسجلة

إرجاع البيانات من EDLs (النقاط الإستراتيجية التي تتلقى الصيانة الدورية من الوكلاء) المسجلة من قبل البلدية.

حدود

اسم	يكتب	وصف
`state`	string	رمز الدولة. مثال: `state=RJ`.
`municipality`	string	اسم البلدية. مثال: `municipality=Ponta Pora`
`country`	string	اسم البلد. مثال: `country=Brasil`. إذا تم حذفه، يفترض "البرازيل".
`page`	int	صفحة ترقيم الصفحات (الافتراضي 1، والحد الأقصى 100).

طلب مثال

curl -G -d "municipality=Vista%20Alegre" \
  /ar-sa/api/getmunicipalityedlspublic

curl -G -d "state=MS" \
  /ar-sa/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 القديم في العمل ويستمر في إرجاع الأسماء القديمة، حتى لا يتم كسر عمليات التكامل في الإنتاج، ولكن تم إيقافه.

حدود

اسم	يكتب	وصف
`state`	string	رمز الدولة. مثال: `state=RJ`.
`municipality`	string	اسم البلدية. مثال: `municipality=Ponta Pora`
`country`	string	اسم البلد. مثال: `country=Brasil`. إذا تم حذفه، يفترض "البرازيل".
`page`	int	صفحة ترقيم الصفحات (الافتراضي 1، والحد الأقصى 100).

طلب مثال

curl -G -d "municipality=Vista%20Alegre" \
  /ar-sa/api/getmunicipalityedlmaintenancepublic

curl -G -d "state=MS" \
  /ar-sa/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عام

مصائد البيض المسجلة

إرجاع البيانات من مصائد البيض (نقاط مراقبة البيض) المسجلة من قبل البلدية.

حدود

اسم	يكتب	وصف
`state`	string	رمز الدولة. مثال: `state=RJ`.
`municipality`	string	اسم البلدية. مثال: `municipality=Ponta Pora`
`country`	string	اسم البلد. مثال: `country=Brasil`. إذا تم حذفه، يفترض "البرازيل".
`page`	int	صفحة ترقيم الصفحات (الافتراضي 1، والحد الأقصى 100).

طلب مثال

curl -G -d "municipality=Vista%20Alegre" \
  /ar-sa/api/getmunicipalityovitrapspublic

curl -G -d "state=MS" \
  /ar-sa/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)

يعيد العقارات (النقاط الاستراتيجية والعقارات الخاصة) المسجلة حسب البلدية.

حدود

اسم	يكتب	وصف
`state`	string	رمز الدولة. مثال: `state=RJ`.
`municipality`	string	اسم البلدية. مثال: `municipality=Ponta Pora`
`country`	string	اسم البلد. مثال: `country=Brasil`. إذا تم حذفه، يفترض "البرازيل".
`page`	int	صفحة ترقيم الصفحات (الافتراضي 1، والحد الأقصى 100).

طلب مثال

curl -G -d "municipality=Vista%20Alegre" \
  /ar-sa/api/getmunicipalityplacespublic

curl -G -d "state=MS" \
  /ar-sa/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 والمستخدم المسؤول.

حدود

اسم	يكتب	وصف
`key`	string	مفتاح API الخاص بك. يحدد نطاق الأعداد التي تم إرجاعها.
`page`	int	صفحة ترقيم الصفحات (الافتراضي 1، والحد الأقصى 100).
`date_start`	date	تاريخ البدء لتصفية الأعداد. مثال: `date_start=2025-01-01`.
`date_end`	date	تاريخ الانتهاء لتصفية الأعداد. مثال: `date_end=2025-12-31`.

إجابات محددة:

400 — عندما لا يكون أي من التواريخ المرسلة بالتنسيق YYYY-MM-DD. الرد يجلب قائمة الحقول غير الصالحة invalid_fields.

طلب مثال

curl -G -d "key=KEY&page=1" \
  /ar-sa/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 المسجلة

إرجاع البيانات من EDLs (النقاط الإستراتيجية التي يزورها الوكلاء بشكل دوري) ضمن النطاق الجغرافي للمفتاح. يتم تحديد النطاق تلقائيًا من خلال الخطة المرتبطة بالمفتاح - البلدية أو الإقليمية أو الولاية أو الدولة - وليس من الضروري إبلاغ البلدية أو الولاية أو الدولة في الطلب.

حدود

اسم	يكتب	وصف
`key`	string	مفتاح API الخاص بك. تحديد النطاق الجغرافي لEDLs المرتجعة.
`page`	int	صفحة ترقيم الصفحات (الافتراضي 1، والحد الأقصى 100).

طلب مثال

curl -G -d "key=KEY&page=1" \
  /ar-sa/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_*.

إرجاع بيانات الزيارات التي تمت لEDLs ضمن النطاق الجغرافي للمفتاح، بما في ذلك الملاحظة المسجلة في كل زيارة. يتم تحديد النطاق تلقائيًا من خلال الخطة المرتبطة بالمفتاح - البلدية أو الإقليمية أو الولاية أو الدولة - وليس من الضروري إبلاغ البلدية أو الولاية أو الدولة في الطلب.

حدود

اسم	يكتب	وصف
`key`	string	مفتاح API الخاص بك. يحدد النطاق الجغرافي للزيارات المرتجعة.
`page`	int	صفحة ترقيم الصفحات (الافتراضي 1، والحد الأقصى 100).

طلب مثال

curl -G -d "key=KEY&page=1" \
  /ar-sa/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

إرجاع بيانات عن الإجراءات (زيارات العلاج) التي تم تنفيذها في كتل ضمن النطاق الجغرافي للمفتاح. يتم تحديد النطاق تلقائيًا من خلال الخطة المرتبطة بالمفتاح - البلدية أو الإقليمية أو الولاية أو الدولة - وليس من الضروري إبلاغ البلدية أو الولاية أو الدولة في الطلب.

حدود

اسم	يكتب	وصف
`key`	string	مفتاح API الخاص بك. يحدد النطاق الجغرافي للإجراءات التي تم إرجاعها.
`page`	int	صفحة ترقيم الصفحات (الافتراضي 1، والحد الأقصى 100).

طلب مثال

curl -G -d "key=KEY&page=1" \
  /ar-sa/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خاص

مصائد البيض المسجلة

إرجاع البيانات من مصائد البيض (نقاط مراقبة البيض) ضمن النطاق الجغرافي للمفتاح. يتم تحديد النطاق تلقائيًا من خلال الخطة المرتبطة بالمفتاح - البلدية أو الإقليمية أو الولاية أو الدولة - وليس من الضروري إبلاغ البلدية أو الولاية أو الدولة في الطلب.

حدود

اسم	يكتب	وصف
`key`	string	مفتاح API الخاص بك. يضبط النطاق الجغرافي لمصائد البيض التي تم إرجاعها.
`page`	int	صفحة ترقيم الصفحات (الافتراضي 1، والحد الأقصى 100).

طلب مثال

curl -G -d "key=KEY&page=1" \
  /ar-sa/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)

يعيد العقارات (النقاط الاستراتيجية والعقارات الخاصة) ضمن النطاق الجغرافي للمفتاح. يُحدَّد النطاق تلقائيًا حسب الخطة المرتبطة بالمفتاح — بلدي أو إقليمي أو على مستوى الولاية أو الدولة — لذا لا حاجة لذكر البلدية أو الولاية أو الدولة في الطلب.

حدود

اسم	يكتب	وصف
`key`	string	مفتاح API الخاص بك. يحدد النطاق الجغرافي للنقاط التي تم إرجاعها.
`page`	int	صفحة ترقيم الصفحات (الافتراضي 1، والحد الأقصى 100).

طلب مثال

curl -G -d "key=KEY&page=1" \
  /ar-sa/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خاص

قراءة التقديم

يرسل قراءة مصيدة البيض. من الممكن إرسال البيانات إلى مصيدة بيض موجودة أو إرسال البيانات وتثبيت مصيدة بيض جديدة في نفس الوقت.

حدود

اسم	يكتب	وصف
`key`	string	مفتاح API الخاص بك. يحدد نطاق التقديم.

طلب مثال

curl -X POST \
  "/ar-sa/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.

بالنسبة للشحن القياسي، حيث لا يكون من الضروري تثبيت Ovitrap جديد، أرسل الحقول التالية (كل إلزامي) في متن الطلب (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	Ovitrap أو لوحة مفقودة
4	Ovitrap أو لوحة مكسورة
5	تمت إزالة Ovitrap أو لوحة الألوان
6	مصيدة البيض الجافة
7	منزل مغلق
8	Ovitrap مملوء بالماء
9	Ovitrap مع القليل من الماء
10	ملاحظة أخرى

لتثبيت ovitrap جديد بجانب الشحنة، إلزامي الحقول: 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
}

جدول بمعرفات كل نوع من مصيدة البيض (ovitrap_type_id): أرسل 1 إلى ovitrap الحضري و2 إلى ovitrap الريفي. الحقل اختياري، وفي حالة عدم إرساله، يتم تثبيت مصيدة البيض على أنها حضرية:

ID	معنى
1	مصيدة البيض الحضرية (معيار)
2	مصيدة البيض الريفية

إجابات محددة:

400 — عندما لا يتم إرسال أي من الحقول الإلزامية: ovitrap_lat, ovitrap_lng, ovitrap_group_id, date
400 — 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خاص

حذف القراءة

يزيل القراءة من مصيدة البيض.

حدود

اسم	يكتب	وصف
`key`	string	مفتاح API الخاص بك. يحدد نطاق الإزالة.

طلب مثال

curl -X POST \
  "/ar-sa/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خاص

حذف أوفيتراب

قم بإزالة مصيدة البيض.

حدود

اسم	يكتب	وصف
`key`	string	مفتاح API الخاص بك.

طلب مثال

curl -X POST \
  "/ar-sa/api/postdeleteovitrap?key=KEY"

البيانات المطلوبة في نص الطلب (form-data, x-www-form-urlencoded ou JSON):

{
  "ovitrap_group_id": 97
}

POST/api/postactionخاص

أدخل الزيارة

تسجيل زيارة/إجراء في كتلة. لإضافة الزيارة إلى كتلة موجودة، أرسل الحقل block_id. إذا لم يكن موجودا، استخدم block_group_id — سيقوم النظام بإنشاء الكتلة تلقائيًا. تسمح نقطة النهاية هذه فقط بإدخال الكتل الموجودة داخل بلدية مقدم الطلب.

حدود

اسم	يكتب	وصف
`key`	string	مفتاح API الخاص بك.

طلب مثال

curl -X POST \
  "/ar-sa/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": 15,

  "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": 15,

  "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 لا يتم إرساله أو عندما لا يكون أحد الحقول الرقمية رقمًا صالحًا.
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خاص

حذف الزيارة

يزيل الزيارة من كتلة واحدة.

حدود

اسم	يكتب	وصف
`key`	string	مفتاح API الخاص بك.

طلب مثال

curl -X POST \
  "/ar-sa/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خاص

حذف الكتلة

يزيل كتلة.

حدود

اسم	يكتب	وصف
`key`	string	مفتاح API الخاص بك.

طلب مثال

curl -X POST \
  "/ar-sa/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.

حدود

اسم	يكتب	وصف
`key`	string	مفتاح API الخاص بك.

طلب مثال

curl -X POST \
  "/ar-sa/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.

حدود

اسم	يكتب	وصف
`key`	string	مفتاح API الخاص بك.

طلب مثال

curl -X POST \
  "/ar-sa/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.

حدود

اسم	يكتب	وصف
`key`	string	مفتاح API الخاص بك.

طلب مثال

curl -X POST \
  "/ar-sa/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.

حدود

اسم	يكتب	وصف
`key`	string	مفتاح API الخاص بك.

طلب مثال

curl -X POST \
  "/ar-sa/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.

حدود

اسم	يكتب	وصف
`key`	string	مفتاح API الخاص بك.

طلب مثال

curl -X POST \
  "/ar-sa/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.

حدود

اسم	يكتب	وصف
`key`	string	مفتاح API الخاص بك.

طلب مثال

curl -X POST \
  "/ar-sa/api/postdeleteplace?key=KEY"

البيانات المطلوبة في نص الطلب (form-data, x-www-form-urlencoded ou JSON):

{
  "place_id": 142
}

واجهة برمجة تطبيقات Conta Ovos

حول واجهة برمجة التطبيقات

المصادقة والمفاتيح

رموز الاستجابة

Como enviar o corpo de um POST

نقاط النهاية العامة

أحدث التهم الصادرة

حدود

طلب مثال

إجابة عينة

زيارات في الكتل

حدود

طلب مثال

إجابة عينة

الكتل المسجلة

حدود

طلب مثال

إجابة عينة

EDL المسجلة

حدود

طلب مثال

إجابة عينة

صيانة EDL

حدود

طلب مثال

إجابة عينة

مصائد البيض المسجلة

حدود

طلب مثال

إجابة عينة

العقارات (places)

حدود

طلب مثال

إجابة عينة

نقاط النهاية الخاصة

أحدث التهم الصادرة

حدود

طلب مثال

إجابة عينة

EDL المسجلة

حدود

طلب مثال

إجابة عينة

صيانة EDL

حدود

طلب مثال

إجابة عينة

Visitas em quarteirões

حدود

طلب مثال

إجابة عينة

مصائد البيض المسجلة

حدود

طلب مثال

إجابة عينة

العقارات (places)

حدود

طلب مثال

إجابة عينة

قراءة التقديم

حدود

طلب مثال

حذف القراءة

حدود

طلب مثال

حذف أوفيتراب

حدود

طلب مثال

أدخل الزيارة

حدود

طلب مثال

حذف الزيارة

حدود

طلب مثال

حذف الكتلة

حدود

طلب مثال

Inserir EDL

حدود

طلب مثال