Une fois que vous avez obtenu la clé du portail Gundi ou de notre équipe d'assistance, incluez-la dans vos requêtes sous forme d'en-tête au format apikey: YOUR_API_KEY. L'API vérifiera la clé à chaque requête afin de confirmer vos droits d'accès et d'identifier la connexion concernée. Les requêtes sans clé, invalides ou expirées seront refusées avec une réponse d'erreur appropriée. Veillez à conserver votre clé API en lieu sûr et à ne pas la partager publiquement, car elle donne accès à des données et opérations potentiellement sensibles.

apikey: 

{{VOTRE_CLÉ_API}}

Publication d'événements

Utilisez le point de terminaison des événements 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}}

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 à partir de la réponse de 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/

{{API_KEY}}

Publier une image

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

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/

{{API_KEY}}

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

Publication d'observations

Les données de mouvement peuvent être publiées via le point de terminaison d'observation. 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}}