1,554
edits
IDigBio Download API: Difference between revisions
add fiendly and other edits.
(add fiendly and other edits.) |
|||
| Line 1: | Line 1: | ||
'''Note: While the download API is currently used by the production portal, it should be considered highly unstable for non-iDigBio consumers. The next revision of the API will most likely be a total rewrite, backend and front. | '''Note: While the download API is currently used by the production portal, it should be considered highly unstable for non-iDigBio consumers. The next revision of the API will most likely be a total rewrite, backend and front. | ||
''' | ''' | ||
'''The download API may not provide "friendly" error messages at this time.''' | |||
== Overview == | |||
The Download API works by performing the requested query and building an archive. Once the archive is completed, the API provides a link to the file. If the optional email parameter is supplied on the query request, an email notification will be sent. | The Download API works by performing the requested query and building an archive. Once the archive is completed, the API provides a link to the file. If the optional email parameter is supplied on the query request, an email notification will be sent. | ||
| Line 20: | Line 23: | ||
<pre> | <pre> | ||
https://csv.idigbio.org/?query={Query in iDigBio query format} | https://csv.idigbio.org/?query={Query in iDigBio query format}[&email={valid email address}] | ||
</pre> | </pre> | ||
See [https://github.com/iDigBio/idigbio-search-api/wiki/Query-Format iDigBio query format] for more information on writing queries. | See [https://github.com/iDigBio/idigbio-search-api/wiki/Query-Format iDigBio query format] for more information on writing queries. | ||
== Examples == | |||
Consider the following query: | |||
<pre> | |||
{ "genus" : "acer"} | |||
</pre> | |||
Without specifying an email address, we could request a download | |||
<pre> | <pre> | ||