API

El catálogo ofrece la información a través de una API basada en RESTful y con respuestas en JSON. Es la versión 1, abierta a toda la comunidad sin restricción y se considera estable para su uso. Información técnica de la api se puede consultar en este enlace.

El acceso se realiza a través de la URL: http://catalogopecesdecolombia.unal.edu.co/results/api/v1/species/{Nombre de especie o URN}, donde el nombre de la especie puede contener espacios o el símbolo + como reemplazo al espacio, por ejemplo:

• http://catalogopecesdecolombia.unal.edu.co/results/api/v1/species/Characidium+zebra
• http://catalogopecesdecolombia.unal.edu.co/results/api/v1/species/Anchoa curta

La API también recibe URN de páginas como WORMS, ZooBank y Catalogue of Life, por ejemplo:

• http://catalogopecesdecolombia.unal.edu.co/results/api/v1/species/urn:lsid:marinespecies.org:taxname:293673

Por último, la api tiene soporte a dos idiomas. Por defecto la información está en español (es), pero si se desea la información en inglés (en) se puede agregar el idioma en la URL, por ejemplo:

• http://catalogopecesdecolombia.unal.edu.co/en/results/api/v1/species/Characidium+zebra
• http://catalogopecesdecolombia.unal.edu.co/es/results/api/v1/species/Characidium+zebra

La api retorna datos en json y los nombres de los campos están en inglés y en minúscula, NULL en el contexto se considera texto vacío y la información de acuerdo a la URL de api está en español o en inglés:

Campo	Tipo	Descripción
lsid	Texto	URN de WORMS, ZooBank o Catálogo de la vida asignado a la especie en el catálogo
species	Texto o NULL	Nombre de la especie
author	Texto	Autoría
genus	Texto	Género de la especio
basins	JSON	Subojeto con 0 a N cuencas
representative	Texto o NULL	Listado de ejemplares representativos
diagnosticChar	Texto o NULL	Características diagnósticas que permitan el reconocimiento de la especie
establishment	Texto o NULL	Origen de la especie
uicn	Texto o NULL	Categoría de amenaza según UICN para la región
nationalRiskCategory	Texto o NULL	Categoría de amanenaza nacional
uses	JSON	Subojeto con 0 a N usos
trophicGuilds	JSON	Subojeto con 0 a N gremios tróficos
reproductiveMode	Texto o NULL	Modo de reproducción de la especie
timeStampCreated	Texto o NULL	Fecha de ingreso del registro a la base de datos del catálogo en formato ISO 8601 [AAAA-MM-DD]
timeStampModified	Texto o NULL	Fecha de actualización del registro a la base de datos del catálogo en formato ISO 8601 [AAAA-MM-DD]