150
edits
IDigBio Download API: Difference between revisions
Jump to navigation
Jump to search
update urls
(update urls) |
|||
| Line 4: | Line 4: | ||
== Overview == | == Overview == | ||
The Download API works by performing the requested query and building a Darwin Core Archive. Once archive generation has begun, the status endpoint can be polled to determine if the generation has been completed. Once the archive generation is completed, the API provides a link to the file for download. If the optional email parameter is supplied on the query request, an email notification will be sent that includes a link to the downloadable file. | The Download API works by performing the requested query and building a Darwin Core Archive. Once archive generation has begun, the status endpoint can be polled to determine if the generation has been completed. Once the archive generation is completed, the API provides a link to the file for download. If the optional email parameter is supplied on the query request, an email notification will be sent that includes a link to the downloadable file. | ||
| Line 31: | Line 24: | ||
<pre> | <pre> | ||
https:// | https://api.idigbio.org/v2/download/?rq={Query in iDigBio query format}[&email={valid email address}] | ||
</pre> | </pre> | ||
| Line 46: | Line 39: | ||
<pre> | <pre> | ||
http:// | http://api.idigbio.org/v2/download/{status uuid} | ||
</pre> | </pre> | ||
| Line 62: | Line 55: | ||
<pre> | <pre> | ||
https:// | https://api.idigbio.org/v2/download/?rq=%7B%22genus%22%3A%22acer%22%7D&email=donotreply%40idigbio.org | ||
</pre> | </pre> | ||
| Line 70: | Line 63: | ||
<pre> | <pre> | ||
$ curl "https:// | $ curl "https://api.idigbio.org/v2/download/?rq=%7B%22genus%22%3A%22acer%22%7D" | ||
{ | { | ||
"download_url" : "http://s.idigbio.org/idigbio-downloads/c5560080-23ce-42eb-a1d8-d663f31c77b8.zip", | "download_url" : "http://s.idigbio.org/idigbio-downloads/c5560080-23ce-42eb-a1d8-d663f31c77b8.zip", | ||
| Line 89: | Line 82: | ||
<pre> | <pre> | ||
$ curl -s "http:// | $ curl -s "http://api.idigbio.org/v2/download/c5560080-23ce-42eb-a1d8-d663f31c77b8" | ||
{ | { | ||
"status_url" : "http://csv.idigbio.org/status/c5560080-23ce-42eb-a1d8-d663f31c77b8", | "status_url" : "http://csv.idigbio.org/status/c5560080-23ce-42eb-a1d8-d663f31c77b8", | ||
| Line 114: | Line 107: | ||
<pre> | <pre> | ||
https:// | https://api.idigbio.org/v2/download/?rq=%7B%22scientificname%22%3A%22puma+concolor%22%7D | ||
</pre> | </pre> | ||