82
edits
IDigBio API: Difference between revisions
Jump to navigation
Jump to search
no edit summary
No edit summary |
No edit summary |
||
| 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. | ||
All iDigBio APIs are publicly available with no user authentication required or rate limits applied. | |||
== Quick Start Example == | == Quick Start Example == | ||
| Line 38: | Line 40: | ||
The version 2 Search API was released in mid 2015 and is the current API that the portal and other iDigBio services are based on. Full documentation for this API is available in the [https://github.com/idigbio/idigbio-search-api/wiki idbsearch-api Github wiki] for the source code. The search API allows you to retrieve limited sets of data in response to custom queries and is typically the one people use. | The version 2 Search API was released in mid 2015 and is the current API that the portal and other iDigBio services are based on. Full documentation for this API is available in the [https://github.com/idigbio/idigbio-search-api/wiki idbsearch-api Github wiki] for the source code. The search API allows you to retrieve limited sets of data in response to custom queries and is typically the one people use. | ||
You can see more [https://github.com/iDigBio/idigbio-search-api/wiki/Examples iDigBio Search API examples] in the [https://github.com/iDigBio/idigbio-search-api/wiki/Examples github wiki]. | |||
=== Download API === | === Download API === | ||
| Line 43: | Line 48: | ||
The Download API can be used to generated [https://en.wikipedia.org/wiki/Darwin_Core_Archive Darwin Core archives] containing any amount of data up to everything that is in iDigBio. This API is documented on the [[iDigBio Download API]] wiki page. This API is useful when the size of the data you want exceeds what you can get through the search API. Be aware that this is not an interactive API; requests will result in a queued job being started to make the Darwin Core archive and you will be informed when it is ready to download later. | The Download API can be used to generated [https://en.wikipedia.org/wiki/Darwin_Core_Archive Darwin Core archives] containing any amount of data up to everything that is in iDigBio. This API is documented on the [[iDigBio Download API]] wiki page. This API is useful when the size of the data you want exceeds what you can get through the search API. Be aware that this is not an interactive API; requests will result in a queued job being started to make the Darwin Core archive and you will be informed when it is ready to download later. | ||
== Other Ways of Accessing Data == | |||
=== Specimen Web Map Module === | === Specimen Web Map Module === | ||
| Line 52: | Line 54: | ||
The iDigBio Portal Search page map is also provided as a stand-alone module for use in any third-party web site. Go to the [[Specimen Map]] page for details on using the map. | The iDigBio Portal Search page map is also provided as a stand-alone module for use in any third-party web site. Go to the [[Specimen Map]] page for details on using the map. | ||
== Full Recordset Downloads == | === Full Recordset Downloads === | ||
Instead of generating large queries in the portal or with the API, it may be easier to download iDigBio data from regular dumps of all data in iDigBio. These dumps are available from [http://s.idigbio.org/idigbio-static-downloads?max-keys=10000 s.idigbio.org]. This is an S3-compatible object store (although it can be treated as a web server if that is easier) that contains .zip files of each record set in iDigBio named by recordset uuid as well as files containing all data across all records sets. | Instead of generating large queries in the portal or with the API, it may be easier to download iDigBio data from regular dumps of all data in iDigBio. These dumps are available from [http://s.idigbio.org/idigbio-static-downloads?max-keys=10000 s.idigbio.org]. This is an S3-compatible object store (although it can be treated as a web server if that is easier) that contains .zip files of each record set in iDigBio named by recordset uuid as well as files containing all data across all records sets. | ||
| Line 67: | Line 69: | ||
== Examples == | == Examples == | ||