API ya Gundi

Kusukuma Data kupitia Gundi

Hadhira

Watoa Huduma za Data ambao wanataka kusambaza data kwa madhumuni ya uhifadhi kwa mifumo yoyote ya Gundi inayotumika (km, EarthRanger , SMART Connect, Movebank, na wpsWatch).

 

Uthibitishaji

Ili kuthibitisha kwa API ya Gundi, jumuisha ufunguo wako wa API kwenye kichwa cha ombi. Kila mteja hutolewa ufunguo wa kipekee wa API.

Kwa kila muunganisho, timu yetu itakupa Ufunguo wa kipekee wa API. Ni muhimu kutambua kwamba funguo haziisha muda, na tunakuhimiza kuziweka salama. Ikiwa unahitaji Ufunguo wa ziada wa API au una maswali yoyote, tafadhali wasiliana nasi kwa support@earthranger.com

 

 

Matukio

Kuchapisha Matukio

Tumia sehemu ya mwisho ya events 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.

Sifa Maelezo Inahitajika
source Hutambua kifaa cha kipekee kinachohusishwa na tukio.

Ndiyo

title Mfuatano unaofaa binadamu kama kichwa cha tukio. Inaonekana katika mlisho wa tukio la EarthRanger na mwonekano wa ramani.

Ndiyo

event_type Inawakilisha aina inayofaa ya Tukio EarthRanger au kategoria ya SMART inayolingana na ripoti.

Ndiyo

recorded_at Muhuri wa muda unaojumuisha saa za eneo, unaopendekezwa katika umbizo la ISO (km, 2023-07-27T09:34-03:00 au 2023-07-27T09:34Z).

Ndiyo

location Kamusi yenye lon (longitudo) na lat (latitudo) kuonyesha eneo la tukio. Thamani za urefu na mwisho ni digrii desimali katika WGS-84.

Ndiyo

event_details Kamusi ya sifa za tukio inayolingana na utaratibu wa "aina ya tukio" husika (katika EarthRanger ) au kategoria (katika SMART Connect).

Hapana

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 '{
   "source":"none",
   "title":"Accident Report",
   "event_type": "accident_rep",
   "recorded_at":"2023-10-03T09:35Z",
   "location":{
       "lat":20.117625,
       "lon":-103.113061
   },
   "event_details":{
       "area":"1",
       "people_affected":"1",
       "tags":[
           "fall",
           "injury"
       ]
   }
}'
'

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}}/' \
--header 'apikey: {{API_KEY}}' \
--header 'Content-Type: application/json' \
--data '{
   "status" : "resolved",
   "location":{
       "lat":13.527,
       "lon":13.154
   },
   "event_details":{
       "number_people_involved":"3"
   }
}'

Kuchapisha Picha

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

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}}/attachments/' \
--header 'apikey: {{API_KEY}}' \
--form 'file1={{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}}
}

 

Uchunguzi

Kuchapisha Uchunguzi

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

Jedwali lifuatalo linaonyesha sifa muhimu ndani ya mzigo wa Nafasi.

Sifa Maelezo Inahitajika
source Kitambulisho cha kipekee cha kifaa kinachoripoti mahali kilipo.

Ndiyo

source_name Jina linalofaa binadamu kwa kifaa. Ikiondolewa, kitambulishi chanzo kitatumika kama chaguomsingi.

Hapana

subject_type Inafafanua huluki inayofuatiliwa (km, 'mgambo', 'tembo', 'helikopta'). Katika EarthRanger , hii inalingana na aina ndogo ya somo.

Hapana

recorded_at Muhuri wa wakati wa wakati nafasi ilirekodiwa, ikijumuisha saa za eneo. Tumia umbizo la ISO (km, 2022-01-10T16:43:32Z) kwa uthabiti.

Ndiyo

location Kamusi iliyo na viwianishi vya alama za wimbo: lon (longitudo) na lat (latitudo) katika digrii desimali (WGS-84).

Ndiyo

additional Kamusi ya jozi maalum za thamani ya vitufe maalum kwa kifaa kinachofuatiliwa, ikiruhusu uhifadhi wa metadata ya ziada zaidi ya sehemu za kawaida.

Hapana

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 '{
   "source": "ST123456789",
   "subject_type": "cow",
   "source_name": "Buttercup",   
   "recorded_at": "2023-10-04T00:44:32Z",
   "location":{
       "lat":-51.769228,
       "lon":-72.004443
   },
   "additional": {
       "speed_kmph": 3
   }
}'
 
 

Kupokea Data kutoka kwa Gundi

Hadhira

Wasanidi programu wanaotaka kupokea data kutoka kwa vitambuzi halisi au pepe vinavyoungwa mkono na Gundi kwa juhudi za uhifadhi.

Uchunguzi wa Ujumuishaji
Ili kugundua fursa za ujumuishaji na Gundi, tafadhali wasiliana na timu yetu.

 
 
 

 

Je, una maswali?

Wasiliana na Usaidizi

Ikiwa unahitaji usaidizi kuhusu Gundi, hizi hapa ni baadhi ya nyenzo za kujaribu.

Wasiliana na timu ya Gundi

Tuma barua pepe kwa support@earthranger.com na maswali yako au maelezo ya suala ambalo umekuwa ukikumbana nalo.

Tusaidie Kuboresha Gundi

Ikiwa una maoni, masahihisho au mapendekezo kuhusu viongozi wetu, tovuti, au tovuti ya Gundi, tafadhali yatumie barua pepe kwa support@earthranger.com .

 

Was this article helpful?