IDigBio API: Difference between revisions

Jump to navigation Jump to search

IDigBio API (view source)

Revision as of 16:22, 9 July 2018

183 bytes added ,  9 July 2018
Moved and changed quick start.
No edit summary
(Moved and changed quick start.)
Line 12: Line 12:


The iDigBio APIs are 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 APIs support HTTP GET and POST requests for data read operations only. The iDigBio APIs are RESTful web services that delivers data primarily as [https://www.json.org/ JSON] documents.
The iDigBio APIs are 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 APIs support HTTP GET and POST requests for data read operations only. The iDigBio APIs are RESTful web services that delivers data primarily as [https://www.json.org/ JSON] documents.
== Quick Start Example ==
The search API is our most useful for most people. Below is a simple example of searching for all records in a given genus to provide you with an example of how this API looks. You can simply click the link in your browser to make the API call and get results:
[https://search.idigbio.org/v2/search/records?rq={%22genus%22:%22acer%22} https://search.idigbio.org/v2/search/records?rq={"genus":"acer"}]
(You might want to install a JSON viewing plugin in your browser such as JSONView for Chrome.)


== iDigBio API Mailing List ==
== iDigBio API Mailing List ==
Line 31: Line 39:
See [https://github.com/iDigBio/idigbio-search-api/wiki/Examples iDigBio API v2 / iDigBio Search API Examples] in the [https://github.com/iDigBio/idigbio-search-api/wiki idigbio-search-api github wiki].
See [https://github.com/iDigBio/idigbio-search-api/wiki/Examples iDigBio API v2 / iDigBio Search API Examples] in the [https://github.com/iDigBio/idigbio-search-api/wiki idigbio-search-api github wiki].


== Quick Start ==
iDigBio API endpoints follow the general form:
;<pre>https://search.idigbio.org/{api_version}/{endpoint}{optional_parameters}</pre>
In nearly all cases, a successful API request returns data as a JSON-formatted document.
Many error cases will also return a JSON-formatted document rather than a bare HTTP status failure.


== Searching iDigBio ==
== Searching iDigBio ==
Mcollins
82

edits

Retrieved from "http://www.idigbio.org/wiki/index.php/Special:MobileDiff/27628"

Navigation menu