Métodos de búsqueda

Los métodos de búsqueda en la API del Catálogo de la Biodiversidad de Colombia son una parte esencial para acceder a la valiosa información sobre la biodiversidad que esta API ofrece. A través de estos métodos, los usuarios pueden realizar consultas específicas y obtener datos detallados sobre diferentes especies y su distribución. Es importante destacar que la API proporciona una interfaz RESTful, lo que significa que los usuarios pueden interactuar con ella mediante solicitudes HTTP estándar, como GET y POST, y recibir respuestas en formatos de datos comunes, como JSON.

La información proporcionada describe dos métodos de búsqueda en la API:

1. Búsqueda Simple (GET /record_search/search):

   • Esta búsqueda permite realizar consultas simples y obtener registros en función de los parámetros de consulta especificados.
   • Parámetros:
     • q (string): Parámetro de búsqueda simple.
     • count (boolean): Si se trata de una consulta para contar el número de documentos encontrados. Valor predeterminado: false.
     • size (integer): Número máximo de resultados a devolver. No puede ser mayor de 1000. Valor predeterminado: 1000.
   • Respuestas:
     • 200: Éxito. Devuelve un array de registros con campos como _id, creation_date, scientificNameSimple, update_date, imageInfo, y threatStatusValue.
     • 400: Error.

2. Búsqueda Avanzada (GET /record_search/advanced_search):

   • Esta búsqueda permite realizar consultas más detalladas y obtener registros en función de varios parámetros de consulta.
   • Parámetros:
     • scientificName (array[string]): Nombre científico.
     • kingdom (array[string]): Nombre del reino.
     • phylum (array[string]): Nombre del filo.
     • class (array[string]): Nombre de la clase.
     • order (array[string]): Nombre del orden.
     • family (array[string]): Nombre de la familia.
     • genus (array[string]): Nombre del género.
     • subGenus (array[string]): Nombre del subgénero.
     • specificEpithet (array[string]): Epíteto específico.
     • infraspecificEpithet (array[string]): Epíteto infraespecífico.
     • department (array[string]): Nombre del departamento.
     • assessment (array[string]): Registros con evaluación de riesgo y extinción.
     • threatUICN (array[string]): Categoría de amenaza (UICN).
     • usos (array[string]): Usos.
     • threatMADS (array[string]): Categoría de amenaza (MADS).
     • threatCITES (array[string]): Categoría de amenaza (CITES).
     • endemic (array[string]): Endémico.
     • habitat (array[string]): Hábitat.
     • invasiveness (boolean): Registros con invasividad. Valor predeterminado: false.
     • exotic (boolean): Registros con valor exótico. Valor predeterminado: false.
     • invasive (boolean): Registros con invasividad. Valor predeterminado: false.
     • multimedia (array[string]): Búsqueda por tipo de multimedia en ancillaryDataApprovedInUse.
     • count (boolean): Si se trata de una consulta para contar el número de documentos encontrados. Valor predeterminado: false.
     • size (integer): Número máximo de resultados a devolver. No puede ser mayor de 1000. Valor predeterminado: 1000.
   • Respuestas:
     • 200: Éxito. Devuelve un array de registros con campos similares a la búsqueda simple.
     • 400: Error.

Estos métodos son útiles para realizar búsquedas y consultar datos en la API.

La Búsqueda Simple es ideal cuando se tiene una consulta general y se busca una variedad de registros que coincidan con un término de búsqueda. Por otro lado, la Búsqueda Avanzada es más adecuada cuando se necesita hacer una búsqueda más específica basada en varios criterios, como el nombre científico, el reino, el hábitat, entre otros. Además, en ambos métodos, es posible limitar el número de resultados devueltos y realizar consultas para contar el número de documentos que coinciden con los criterios de búsqueda.

Es importante destacar que la API devuelve información en formato JSON y contiene detalles sobre los registros, como el nombre científico, la fecha de creación, la información de la imagen y el estado de amenaza. Los desarrolladores y analistas de datos pueden utilizar estos métodos de búsqueda para consultar y extraer datos útiles relacionados con la biodiversidad para diversos fines, como análisis, investigación o desarrollo de aplicaciones centradas en la conservación de la biodiversidad.

Ejemplos

Ejemplos en curl para realizar consultas a la API del Catálogo de Biodiversidad de Colombia utilizando los dos métodos de búsqueda: GET /record_search/search y GET /record_search/advanced_search.

Método 1: GET /record_search/search

Este método te permite realizar búsquedas de registros en el catálogo utilizando parámetros en la URL. Por ejemplo, puedes buscar registros de una especie en particular.

Ejemplo de curl para buscar registros de la especie "Ocelote" (Leopardus pardalis):

Ver en el navegador

curl "http://api.catalogo.biodiversidad.co/record_search/search?q=Leopardus%20pardalis"
                    

En este ejemplo, estamos usando el parámetro q para buscar registros de la especie "Leopardus pardalis" (Ocelote).

Método 2: GET /search/records

Este método te permite realizar búsquedas de registros en el catálogo enviando parámetros QUERY en la solicitud GET. Esto es útil si deseas especificar múltiples criterios de búsqueda o realizar consultas más complejas.

Ejemplo de curl para buscar registros de mamíferos en el departamento de Antioquia, Colombia:

Ver en el navegador

curl -X GET "http://api.catalogo.biodiversidad.co/record_search/advanced_search?class=Mammalia&orden=Primates"

En este ejemplo, estamos enviando los parámetros con dos criterios de búsqueda: class para buscar registros de mamíferos y orden para limitar la búsqueda a Primates.

Estos ejemplos son solo ilustrativos y es posible que necesites ajustar los parámetros y valores según tus necesidades específicas de búsqueda en el catálogo de biodiversidad. Además, como la API puede cambiar, te recomiendo consultar la documentación actualizada para obtener la información más reciente sobre cómo utilizar la API.