Enviar datos a través de Gundi
Audiencia
Proveedores de datos que quieran transmitir datos con fines de conservación a cualquiera de las plataformas compatibles con Gundi (por ejemplo, EarthRanger , SMART Connect, Movebank y wpsWatch).
Autenticación
Para autenticarse con la API de Gundi, incluya su clave API en el encabezado de la solicitud. A cada cliente se le proporciona una clave API única.
Para cada conexión, nuestro equipo le proporcionará una clave API única. Es importante tener en cuenta que las claves no caducan y le recomendamos que las guarde en un lugar seguro. Si necesita una clave API adicional o tiene alguna consulta, comuníquese con nosotros a support@earthranger.com
Eventos
Publicación de eventos
Utilice el punto de conexión events
para compartir información sobre eventos. Los eventos se pueden utilizar 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. | Sí |
title |
Una cadena de caracteres que se puede leer como título del evento. Aparece en la fuente de eventos y en la vista del mapa de EarthRanger . | Sí |
event_type |
Representa el tipo de evento EarthRanger apropiado 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: {{YOUR_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 la operación es exitosa, nuestra API v2 le proporcionará un ID de objeto, que puede utilizarse más adelante para diversas actualizaciones y casos de uso. Asegúrese de anotar este {{OBJECT_ID}}
si prevé que 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 desea modificar.
El siguiente ejemplo ilustra la actualización de la ubicación, el estado y una propiedad adicional de un evento. Reemplace el marcador de posición {{OBJECT_ID}}
con el ID único obtenido de la respuesta de creación del evento. Para obtener más detalles sobre cómo obtener este ID, consulte la sección anterior.
curl --location --request PATCH 'https://sensors.api.gundiservice.org/v2/events/{{OBJECT_ID}}/' \
--header 'apikey: {{YOUR_API_KEY}}' \
--header 'Content-Type: application/json' \
--data '{
"status" : "resolved",
"location":{
"lat":13.527,
"lon":13.154
},
"event_details":{
"number_people_involved":"3"
}
}'
Publicar una imagen
Las imágenes de cámaras trampa se pueden adjuntar a eventos mediante el punto final attachments
.
Este ejemplo ilustra el proceso de actualización de un evento con una imagen a través de la API de Gundi. Preste atención al marcador de posición {{OBJECT_ID}}
en el punto final, 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/{{OBJECT_ID}}/attachments/' \
--header 'apikey: {{YOUR_API_KEY}}' \
--form 'file1={{Blob}}'
Si la operación es exitosa, nuestra API le proporcionará un ID de objeto, que puede utilizar más adelante para diversas actualizaciones y casos de uso. Asegúrese de anotar este ID de objeto si prevé que necesitará la funcionalidad adicional.
200 OK
{
"object_id": {{OBJECT_ID}},
"created_at": {{CREATED_AT}}
}
Observaciones
Publicación de observaciones
Los datos de movimiento se pueden publicar mediante el punto de observations
. Las observaciones se pueden utilizar para rastrear la vida silvestre, los guardabosques y los activos.
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 sencillo para el dispositivo. Si se omite, se utilizará el identificador de origen como predeterminado. | No |
subject_type |
Describe la entidad que se está rastreando (por ejemplo, 'guardabosques', 'elefante', 'helicóptero'). En EarthRanger , esto corresponde al subtipo del sujeto. | No |
recorded_at |
La marca de tiempo en la que se registró la posición, incluida la zona horaria. Utilice el formato ISO (por ejemplo, 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: {{YOUR_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
}
}'
Obtener datos a través de Gundi
Audiencia
Desarrolladores interesados en recibir datos de sensores físicos o virtuales apoyados por Gundi para esfuerzos de conservación.
Investigación de integración
Para explorar oportunidades de integración con Gundi, comuníquese con nuestro equipo.