IDigBio API: Difference between revisions

Jump to navigation Jump to search
307 bytes removed ,  28 May 2014
Line 11: Line 11:
Many consumers of the iDigBio aggregated data will choose to use the [https://www.idigbio.org/portal iDigBio Portal web site]. Additionally, to facilitate integration of iDigBio data with other web sites or services, iDigBio provides an API.
Many consumers of the iDigBio aggregated data will choose to use the [https://www.idigbio.org/portal iDigBio Portal web site]. Additionally, to facilitate integration of iDigBio data with other web sites or services, iDigBio provides an API.


The iDigBio API is an abstraction layer for retrieving data from the iDigBio back-end data systems. This abstraction allows reuse and mashup of aggregated data without needing to understand the complex underlying details of the back-end data storage. Currently, the public API supports GET requests for data read operations only.
The iDigBio API is an abstraction layer for retrieving data from the iDigBio back-end data systems. This abstraction allows reuse and mashup of aggregated data without needing to understand the complex underlying details of the back-end data storage. Currently, the public API supports GET requests for data read operations only. The iDigBio API is a RESTful web service that delivers data primarily as JSON documents.
 
The iDigBio API tries to follow the REST paradigm's HATEOAS (Hypermedia as the Engine of Application State) model, which basically means that within each API endpoint a list of relevant links to further API actions is included. Successful responses from the API deliver data primarily as JSON documents. The list of relevant links to further API actions is typically stored in "idigbio:links".  


Programmatic Search is a special case. See the section [[#Searching iDigBio]] below for more information.
Programmatic Search is a special case. See the section [[#Searching iDigBio]] below for more information.
1,554

edits

Navigation menu