CRIA speciesLink API v.0.1 beta
Centro de Referência em Informação Ambiental, CRIA

Synopsis

The goal of this API is to facilitate the access to the speciesLink network data from within other applications.
The calls can be done using HTTP GET or POST methods.
When using GET, the parameters should be passed to the API through a REST like URL.
When using POST, the parameters should be passed in a JSON document.

The access point of the API is always https://api.splink.org.br

The first parameter is always the operation to be performed and must be present in both access methods (GET or POST).
They can be HELP, DATASETS or RECORDS. ( E.g. https://api.splink.org.br/records )

Operations

HELP

The HELP operation shows this page. If a not valid operation, or none, is specified the help operation is called.

Access point: http://api.splink.org.br/help

DATASETS

Returns a list of all datasets available in the speciesLink for searching.

Access point: http://api.splink.org.br/datasets

modifiers

Format JSON | XML | CSV | TAB

example

http://api.splink.org.br/datasets/format/json

RECORDS

Returns the records, result of a search.

Access point: http://api.splink.org.br/records

searcheable fields

@ = accepts ARRAY
$ = scalar only
* = implemented

Note: values of parameters that accept ARRAY should be separated by slash ( / ) in the URL (GET) or in a JSON ARRAY. See examples below.

@ *	Barcode		NY00000001 | FPS00257 | FCM00096 | UEC006758
@ *	BasisOfRecord	PreservedSpecimen | LivingSpecimen | FossilSpecimen | HumanObservation | MachineObservation | MaterialSample	PreservedSpecimen
@	InstitutionCode	sinstitution acronym	UNICAMP | Fiocruz
@ *	CollectionCode	collection acronym	FIOCRUZ-CEIOC | UEC | HUEFS
@ *	CatalogNumber	number	435643 | embranco | nãobranco
@ *	Collector	collector name	Kock | Almeida F
@ *	CollectorNumber	number	125 | 1897
@ *	YearCollected	four-digits year	1987 | 1897 | 2016
@ *	IdentifiedBy		Abreu MC
@ *	YearIdentified	four-digits year	1887 | 1997 | 2015
@ *	Kingdom		Plantae | Animalia | Fungi
@ *	Phylum
@ *	Class
@ *	Order
@ *	Family		Bromeliaceae | Apidae
@ *	Genus		Tabebuia | Bacillus | Boa | Hoplias
@ *	ScientificName		Bothrops neuwiedii matogrossensis | Leishmania braziliensis
@ *	TypeStatus
@ *	Country
@ *	StateProvince
@ *	County
@ *	Locality
@	Notes

modifiers

$ *	CoordinatesQuality	Good | Bad	 any coordinates 
$ *	Format			JSON | XML | CSV | TAB
$ *	Separator		comma | semicolon	Valid only for Format = CSV
$ *	MaxRecords		n > 0	 all records 
$ *	Model			DwC | modelling
$ *	Phonetic		Yes | No	  affects only taxonomic fields: class, phylum, order, family, genus, scientificname  
$ *	RedList			Yes | No	  no check  
$ *	Scope			plants, animals, microrganisms,fossils	 all groups 
$ *	Coordinates		Yes | No | Original | Automatic | Blocked	  no check  
$ *	Images			Yes | No | Live | Polen | Wood	  no check 
$	Synonyms		sp2000 | flora2020 | MycoBank | AlgaeBase | DSMZ | Moure   no synonyms  
$ *	Typus			Yes | No 	  no check 
$ *	ShowEmptyValues		Yes | No
$ *	fieldsCase		Lower | Upper | Mixed
$ *	Summary			Yes | No

output by model

field	DwC	Modelling	Coords
modified	x
institutionCode	x	x
collectionCode	x	x
catalogNumber	x	x
basisOfRecord	x	x
kingdom	x	x
phylum	x	x
class	x	x
order	x	x
family	x	x
genus	x	x	x
specificEpithet	x	x	x
infraspecificEpithet	x	x
scientificName	x	x
scientificNameAuthorship	x	x
identifiedBy	x	x
yearIdentified	x	x
monthIdentified	x	x
dayIdentified	x	x
typeStatus	x	x
recordedBy	x	x
recordNumber	x	x
fieldNumber	x
year	x	x
month	x	x
day	x
eventTime	x
continentOcean	x	x
country	x	x
stateProvince	x	x
county	x	x
locality	x	x
decimalLongitude	x	x	x
decimalLatitude	x	x	x
verbatimLongitude	x	x	x
verbatimLatitude	x	x	x
coordinatePrecision	x	x	x
boundingBox	x
minimumElevationInMeters	x
maximumElevationInMeters	x
minimumDepthInMeters	x
maximumDepthInMeters	x
sex	x
preparationType	x	x
individualCount	x
previousCatalogNumber	x
relationshipType	x
relatedCatalogItem	x
occurrenceRemarks	x	x
barcode	x	x

example 1

curl -XGET 'http://api.splink.org.br/records/CollectionCode/uec/ScientificName/Rauvolfia sellowii/Cantinoa althaeifolia/Images/yes'

equivalent to

curl -XPOST 'http://api.splink.org.br/records' -d '
{	"CollectionCode": "uec",
	"ScientificName": ["Rauvolfia sellowii","Cantinoa althaeifolia"],
	"Images"	: "yes"
}
'

example 2

curl -XGET 'http://api.splink.org.br/records/ScientificName/Rauvolfia sellowii/Cantinoa althaeifolia/StateProvince/São Paulo/Rio de Janeiro/Pernambuco/Synonyms/flora2020'

or the correctly encoded

curl -XGET 'http://api.splink.org.br/records/ScientificName/Rauvolfia%20sellowii/Cantinoa%20althaeifolia/StateProvince/São%20Paulo/Rio%20de%20Janeiro/Pernambuco/Synonyms/flora2020'

equivalent to

curl -XPOST 'http://api.splink.org.br/records' -d '
{	"Scientificname":	[ "Rauvolfia sellowii", "Cantinoa althaeifolia" ],
	"StateProvince"	:	["São Paulo","Rio de Janeiro","Pernambuco"],
	"Synonyms"	: "flora2020"
}
'

example 3

this kind of query should be requested only using POST as depending on the size of the URL the call may be invalid 

curl -XPOST 'http://api.splink.org.br/records' -d '
{
        "County" : ["São José do Rio Pardo","Mococa","Cajuru"],
        "Synonyms" : "flora2020",

        "Scientificname": [
"Abarema turbinata",
"Comolia villosa",
"Stylosanthes campestris",
"Vochysia floribunda",
"Eugenia platyphylla",
"Chaetocalyx acutifolia",
"Actinocephalus ochrocephalus",
"Cicuta douglasii",
"Annona senegalensis",
"Hexasepalum radula",
"Trichosalpinx dura",
"Allophylus sericeus",
"Microlicia juniperina",
"Campomanesia pubescens",
"Luxemburgia ciliosa",
"Dalechampia humilis",
"Croton heliotropiifolius",
"Senna alata",
"Ipomoea dichotoma",
"Arundo donax"

      ]
}
'

Valid CollectionCodes