Public

Fournisseurs de données qui souhaitent transmettre des données à des fins de conservation à l'une des plates-formes prises en charge par Gundi (par exemple, EarthRanger , SMART Connect, Movebank et wpsWatch).

Authentification

Pour vous authentifier auprès de l'API Gundi, incluez votre clé API dans l'en-tête de la requête. Chaque client reçoit une clé API unique.

Événements

Publication d'événements

Utilisez le point de terminaison events pour partager des informations sur les événements. Les événements peuvent être utilisés pour les rapports, les alertes, les incidents ou tout événement nécessitant une attention ou une action.

Le tableau suivant décrit les propriétés essentielles d’une charge utile d’événement.

L'exemple suivant illustre l'utilisation du point de terminaison /events/ .

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

Si l'opération réussit, notre API v2 vous fournira un identifiant d'objet, utilisable ultérieurement pour diverses mises à jour et cas d'utilisation. N'oubliez pas de noter cet {{OBJECT_ID}} si vous prévoyez d'avoir besoin de cette fonctionnalité supplémentaire.

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

Mise à jour des événements

Pour mettre à jour un événement précédemment envoyé à l'API de Gundi, utilisez la méthode PATCH et incluez uniquement les propriétés que vous souhaitez modifier.

L'exemple suivant illustre la mise à jour de l'emplacement, du statut et d'une propriété supplémentaire d'un événement. Remplacez l'espace réservé {{OBJECT_ID}} par l'ID unique obtenu lors de la création de l'événement. Pour plus d'informations sur l'obtention de cet ID, reportez-vous à la section précédente.

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

Publier une image

Les images de pièges photographiques peuvent être jointes à des événements à l'aide du point de terminaison attachments .

Cet exemple illustre le processus de mise à jour d'un événement avec une image via l'API Gundi. Attention à l'espace réservé {{OBJECT_ID}} dans le point de terminaison, qui doit être remplacé par la valeur obtenue à partir du résultat de la création de l'événement (voir « Publication d'événements »).

 curl --location 'https://sensors.api.gundiservice.org/v2/events/{{OBJECT_ID}}/attachments/' \
--header 'apikey: {{API_KEY}}' \
--form 'file1={{Blob}}'

Si l'opération réussit, notre API vous fournira un identifiant d'objet, utilisable ultérieurement pour diverses mises à jour et cas d'utilisation. Notez cet identifiant si vous prévoyez d'utiliser cette fonctionnalité supplémentaire.

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

Observations

Publication d'observations

Les données de mouvement peuvent être publiées via le point de terminaison observations . Ces observations permettent de suivre la faune, les gardes forestiers et les biens.

Le tableau suivant décrit les propriétés essentielles d’une charge utile de position.

L'exemple suivant illustre l'utilisation du point de terminaison /observations/ .

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

Public

Les développeurs intéressés à recevoir des données de capteurs physiques ou virtuels pris en charge par Gundi pour les efforts de conservation.