Gundi's API

Utangulizi

API ya Gundi imeundwa ili kuwezesha watoa huduma za data kusambaza data inayokusudiwa kwa mifumo mbalimbali inayotumika (km, EarthRanger , SMART, Movebank, na wpsWatch).

URL ya msingi

https://sensors.api.gundiservice.org/v2/

Umbizo la Majibu

Majibu yote yako katika umbizo la JSON.

Inatayarisha

Hati hizi ni za toleo la v2 la API.

Vikomo vya Viwango

Gundi inaweza kuchakata idadi kubwa ya data bila kutekeleza kikomo cha kiwango. Hata hivyo, mifumo lengwa (kama vile EarthRanger ) inaweza kuwa na ugumu wa kushughulikia data inapotumwa kwa kasi maalum ya karibu eneo moja kwa sekunde kwa kila kifaa. Katika hali kama hizi, Gundi hujaribu tena kiotomatiki, lakini tunapendekeza uwasiliane na timu ya Gundi ikiwa unatarajia kutuma data kwa masafa haya.

Uthibitishaji

Miisho yote inahitaji ufunguo wa API uliotumwa kwa kichwa cha Authorization :

apikey: API_KEY

Ufunguo huu unaweza kupatikana kutoka kwa Muunganisho wako ulioundwa katika Tovuti ya Gundi . Angalia hati zetu ili kuunda Muunganisho mpya, au uombe Ufunguo wa API kutoka kwa Timu yetu ya Usaidizi. Maombi ambayo hayajumuishi ufunguo, au yanajumuisha ufunguo batili au ulioisha muda, yatakataliwa kwa jibu linalofaa la hitilafu.

Tafadhali weka ufunguo wako wa API salama na usiushiriki hadharani, kwani hutoa ufikiaji wa data nyeti na utendakazi.

Muhtasari wa Ujumuishaji


POST /events/

Matukio yanaweza kutumika kwa ripoti, arifa, matukio au tukio lolote linalohitaji ufahamu au hatua.

Vichwa Vinavyohitajika

Kijajuu Thamani Maelezo
apikey {{API_KEY}} Ufunguo wako wa API kwa uthibitishaji
Content-Type application/json Hubainisha aina ya midia ya mwili

Vigezo vya Maswali

Sifa
source Hutambua kifaa cha kipekee kinachohusishwa na tukio.

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

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

inahitajika
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).

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

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

hiari

Mwili wa Ombi

{
 	"source": "{{SOURCE_ID}}",
 	"title": "{{EVENT_TITLE}}",
 	"event_type": "{{EVENT_TYPE}}",
 	"recorded_at": "{{TIMESTAMP}}",
 	"location": {
   		"lat": {{LATITUDE}},
   		"lon": {{LONGITUDE}}
 	},
 	"event_details": {
 	}
}

Mfano

{
   "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"
      ]
   }
}

Jibu

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}} 
}


PATCH /events/{object_id}/

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

Vichwa Vinavyohitajika

Kijajuu Thamani Maelezo
apikey {{API_KEY}} Ufunguo wako wa API kwa uthibitishaji
Content-Type application/json Hubainisha aina ya midia ya mwili

Mfano

{
   "status":"resolved",
   "location":{
      "lat":13.527,
      "lon":13.154
   },
   "event_details":{
      "number_people_involved":"3"
   }
}


PATCH /events/{object_id}/attachments/

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

Vichwa Vinavyohitajika

Kijajuu Thamani Maelezo
apikey {{API_KEY}} Ufunguo wako wa API kwa uthibitishaji
Content-Type application/json Hubainisha aina ya midia ya mwili

Ombi la Mfano

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}}'


POST /observations/

Uchunguzi unaweza kutumika kufuatilia wanyamapori, walinzi na mali.

Vichwa Vinavyohitajika

Kijajuu Thamani Maelezo
apikey {{API_KEY}} Ufunguo wako wa API kwa uthibitishaji
Content-Type application/json Hubainisha aina ya midia ya mwili

Vigezo vya Maswali

Sifa
source Kitambulisho cha kipekee cha kifaa kinachoripoti mahali kilipo.

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

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

hiari
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.

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

inahitajika
additional

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

Sehemu hii inaweza kupokea JSON yoyote halali.

hiari

Mwili wa Ombi

{
 	"source": "{{SOURCE_ID}}",
 	"subject_type": "{{SUBJECT_TYPE}}",
 	"source_name": "{{SOURCE_NAME}}",
 	"recorded_at": "{{TIMESTAMP}}",
 	"location": {
   		"lat": {{LATITUDE}},
   		"lon": {{LONGITUDE}}
 	},
 	"additional": {
 	}
}

Mfano

{
   "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
   }
}

 

Ijaribu katika Postman

Gundua Mkusanyiko wa Postman

 

Sasisho la mwisho: Agosti 3, 2025