Ukishapata ufunguo kutoka kwa Tovuti ya Gundi au Timu yetu ya Usaidizi, ujumuishe katika maombi yako kama kichwa kwa kutumia umbizo la apikey: YOUR_API_KEY. API itathibitisha ufunguo kwa kila ombi ili kuthibitisha haki zako za ufikiaji na kutambua Muunganisho husika. Maombi ambayo hayajumuishi ufunguo, au yanajumuisha ufunguo batili au ulioisha muda, yatakataliwa kwa jibu linalofaa la hitilafu. Hakikisha kuwa umeweka ufunguo wako wa API salama na usiushiriki hadharani, kwa kuwa hutoa ufikiaji wa data na shughuli zinazoweza kuwa nyeti.

apikey: {{UFUNGUO_WAKO_API}}

Kuchapisha Matukio

Tumia sehemu ya mwisho ya matukio kushiriki maelezo ya tukio. Matukio yanaweza kutumika kwa ripoti, arifa, matukio au tukio lolote linalohitaji ufahamu au hatua.

Jedwali lifuatalo linaonyesha sifa muhimu ndani ya malipo ya tukio.

Mfano ufuatao unaonyesha matumizi ya /events/ endpoint.

curl --location 'https://sensors.api.gundiservice.org/v2/events/' \
--header 'Content-Type: application/json' \
--header 'apikey: {{API_KEY}}' \
--data '{
   "chanzo":"hapana",
   "kichwa":"Ajali Ripoti",
   "aina_ya_tukio": "msimamizi_wa_ajali",
   "iliyorekodiwa_saa":"2023-10-03T09:35Z",
   "mahali":{
       "lat":20.117625,
       "loni":-103.113061
   },
   "maelezo_ya_tukio":{
       "eneo":"1",
       "watu_walioathirika":"1",
       "tagi":[
           "kuanguka",
           "jeraha"
       ]
   }
}'
'

Uendeshaji ukifaulu, API yetu v2 itakupa Kitambulisho cha Kitu, ambacho kinaweza kutumika baadaye kwa masasisho na matukio mbalimbali ya utumiaji. Hakikisha kuwa umeandika {{OBJECT_ID}} ikiwa unatarajia kuhitaji utendakazi wa ziada.

200 OK
{ 
  "object_id": {{OBJECT_ID}}, 
  "created_at": {{CREATED_AT}} 
}

Inasasisha Matukio

Ili kusasisha tukio lililotumwa hapo awali kwa API ya Gundi, tumia mbinu ya PATCH na ujumuishe sifa unazotaka kurekebisha pekee.

Mfano ufuatao unaonyesha kusasisha eneo la tukio, hali, na sifa ya ziada. Badilisha kishika nafasi cha {{OBJECT_ID}} kwa kitambulisho cha kipekee kilichopatikana kutokana na jibu la kuunda tukio. Kwa maelezo zaidi kuhusu jinsi ya kupata kitambulisho hiki, rejelea sehemu iliyotangulia.

curl --location --request PATCH 'https://sensors.api.gundiservice.org/v2/events/{{OBJECT_ID}}/' \
--kichwa 'apikey: {{API_KEY}}' \
--kichwa 'AinayaMaudhui: maombi/json' \
--data '{
   "hali" : "kutatuliwa",
   "mahali":{
       "lat":13.527,
       "loni":13.154
   },
   "maelezo_ya_tukio":{
       "idadi_ya_watu_wanaohusika":"3"
   }
}'

Kuchapisha Picha

Picha za mtego wa kamera zinaweza kuambatishwa kwa matukio kwa kutumia sehemu ya mwisho ya viambatisho.

Mfano huu unaonyesha mchakato wa kusasisha tukio na picha kupitia API ya Gundi. Zingatia kishika nafasi cha {{OBJECT_ID}} katika sehemu ya mwisho, ambacho kinafaa kubadilishwa na thamani iliyopatikana kutokana na matokeo ya uundaji wa tukio (rejelea "Matukio ya Kuchapisha").

curl --location 'https://sensors.api.gundiservice.org/v2/events/{{OBJECT_ID}}/viambatisho/' \
--kichwa 'apikey: {{API_KEY}}' \
--fomu 'faili1={{Blob}}'

Uendeshaji ukifaulu, API yetu itakupa Kitambulisho cha Kitu, ambacho kinaweza kutumika baadaye kwa masasisho na matukio mbalimbali ya utumiaji. Hakikisha umeandika Kitambulisho hiki cha Kitu ikiwa unatarajia kuhitaji utendakazi wa ziada.

200 OK
{
   "object_id": {{OBJECT_ID}},
   "created_at": {{CREATED_AT}}
}

Kuchapisha Uchunguzi

Data ya harakati inaweza kuchapishwa kwa kutumia sehemu ya mwisho ya uchunguzi. Uchunguzi unaweza kutumika kufuatilia wanyamapori, walinzi na mali.

Jedwali lifuatalo linaonyesha sifa muhimu ndani ya mzigo wa Nafasi.

Mfano ufuatao unaonyesha matumizi ya /observations/ endpoint.

curl --location 'https://sensors.api.gundiservice.org/v2/observations/' \
--header 'Content-Type: application/json' \
--header 'apikey: {{API_KEY}}' \
--data '{
   "chanzo": "ST123456789",
   "aina_ya_somo": "ng'ombe",
   "chanzo_jina": "Buttercup",   
   "iliyorekodiwa_saa": "2023-10-04T00:44:32Z",
   "mahali":{
       "lat":-51.769228,
       "loni":-72.004443
   },
   "ziada": {
       "speed_kmph": 3
   }
}'