Impulsando datos a través de Gundi
La API de Gundi está diseñada para permitir que los proveedores de datos transmitan datos destinados a diversas plataformas compatibles (por ejemplo, EarthRanger , SMART, Movebank y wpsWatch).
Autenticación
Esta API utiliza autenticación basada en claves API. Para autenticarse, debe obtener una clave API de la conexión creada a través del portal de Gundi.
Clave API
Una vez que reciba la clave del Portal de Gundi o de nuestro Equipo de Soporte, inclúyala en sus solicitudes como encabezado con el formato apikey: YOUR_API_KEY. La API verificará la clave en cada solicitud para confirmar sus derechos de acceso e identificar la conexión correspondiente. Las solicitudes que no incluyan una clave, o que incluyan una clave no válida o caducada, serán denegadas con un error. Asegúrese de mantener su clave API segura y no la comparta públicamente, ya que proporciona acceso a datos y operaciones potencialmente sensibles.
apikey:
{{SU_CLAVE_API}}
Eventos
Los eventos se pueden utilizar para informes, alertas, incidentes o cualquier evento que requiera conciencia o acción.
https://sensors.api.gundiservice.org/v2/eventos/
Publicación de eventos
Utilice el punto de conexión de eventos para compartir información sobre eventos. Los eventos se pueden usar para informes, alertas, incidentes o cualquier evento que requiera conocimiento o acción.
La siguiente tabla describe las propiedades esenciales dentro de una carga útil de evento.
Atributo | Descripción | Requerido |
---|---|---|
source |
Identifica un dispositivo único asociado con el evento. | No |
title |
Una cadena de texto intuitivo como título del evento. Aparece en el feed de eventos y la vista del mapa de EarthRanger . | Sí |
event_type |
Representa el tipo de evento EarthRanger o la categoría SMART correspondiente al informe. | Sí |
recorded_at |
Una marca de tiempo que incluye una zona horaria, recomendada en formato ISO (por ejemplo, 2023-07-27T09:34-03:00 o 2023-07-27T09:34Z). | Sí |
location |
Un diccionario con lon (longitud) y lat (latitud) para indicar la ubicación del evento. Los valores de lon y lat son grados decimales en WGS-84. | Sí |
event_details |
Un diccionario de propiedades de eventos que coinciden con el esquema del "tipo de evento" asociado (en EarthRanger ) o categoría (en SMART Connect). | No |
El siguiente ejemplo demuestra el uso del punto final /events/.
curl --location 'https://sensors.api.gundiservice.org/v2/events/' \
--header 'Content-Type: application/json' \
--header 'apikey:
{{CLAVE_API}}
Si la operación se realiza correctamente, nuestra API v2 le proporcionará un ID de objeto, que podrá utilizar posteriormente para diversas actualizaciones y casos de uso. Asegúrese de anotar este {{OBJECT_ID}}
si prevé necesitar la funcionalidad adicional.
200 OK
{
"object_id": {{OBJECT_ID}},
"created_at": {{CREATED_AT}}
}
Actualización de eventos
Para actualizar un evento enviado previamente a la API de Gundi, utilice el método PATCH e incluya solo las propiedades que desee modificar.
El siguiente ejemplo ilustra la actualización de la ubicación, el estado y una propiedad adicional de un evento. Reemplace el marcador {{OBJECT_ID}}
con el ID único obtenido de la respuesta de creación del evento. Para obtener más información sobre cómo obtener este ID, consulte la sección anterior.
curl --location --request PATCH 'https://sensors.api.gundiservice.org/v2/events/
{{CLAVE_API}}
Publicar una imagen
Es posible adjuntar imágenes de cámaras trampa a eventos mediante el punto final de archivos adjuntos.
Este ejemplo ilustra el proceso de actualización de un evento con una imagen mediante la API de Gundi. Preste atención al marcador {{OBJECT_ID}}
en el endpoint, que debe sustituirse por el valor obtenido del resultado de la operación de creación del evento (consulte "Publicación de eventos").
curl --location 'https://sensors.api.gundiservice.org/v2/events/
{{CLAVE_API}}
Si la operación se realiza correctamente, nuestra API le proporcionará un ID de objeto, que podrá utilizar posteriormente para diversas actualizaciones y casos de uso. Asegúrese de anotar este ID de objeto si prevé necesitar la funcionalidad adicional.
200 OK
{
"object_id": {{OBJECT_ID}},
"created_at": {{CREATED_AT}}
}
Observaciones
Las observaciones se pueden utilizar para realizar un seguimiento de la vida silvestre, los guardabosques y los activos.
https://sensors.api.gundiservice.org/v2/observaciones/
Publicación de observaciones
Los datos de movimiento se pueden publicar mediante el punto de observación. Las observaciones se pueden usar para rastrear la fauna silvestre, los guardabosques y los recursos.
La siguiente tabla describe las propiedades esenciales dentro de una carga útil de posición.
Atributo | Descripción | Requerido |
---|---|---|
source |
Un identificador único para el dispositivo que informa su posición. | Sí |
source_name |
Un nombre intuitivo para el dispositivo. Si se omite, se usará el identificador de origen como predeterminado. | No |
subject_type |
Describe la entidad rastreada (p. ej., 'guardabosques', 'elefante', 'helicóptero'). En EarthRanger , esto corresponde al subtipo del sujeto. | No |
recorded_at |
Marca de tiempo del registro de la posición, incluyendo la zona horaria. Utilice el formato ISO (p. ej., 2022-01-10T16:43:32Z) para mantener la coherencia. | Sí |
location |
Un diccionario que contiene las coordenadas del punto de seguimiento: lon (longitud) y lat (latitud) en grados decimales (WGS-84). | Sí |
additional |
Un diccionario para pares clave-valor personalizados específicos del dispositivo rastreado, que permite el almacenamiento de metadatos adicionales más allá de los campos estándar. | No |
El siguiente ejemplo demuestra el uso del punto final /observations/.
curl --location 'https://sensors.api.gundiservice.org/v2/observations/' \
--header 'Content-Type: application/json' \
--header 'apikey:
{{CLAVE_API}}