1,554
edits
IDigBio Download API: Difference between revisions
add categories
(add fiendly and other edits.) |
(add categories) |
||
| Line 1: | Line 1: | ||
[[Category:CYWG]] | |||
[[Category:API]] | |||
[[Category:Documentation]] | |||
== Overview == | |||
'''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. | ||
''' | ''' | ||
| Line 4: | Line 10: | ||
'''The download API may not provide "friendly" error messages at this time.''' | '''The download API may not provide "friendly" error messages at this time.''' | ||
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 53: | Line 59: | ||
When the download file is generated, the "complete" field will be set to "true" and the "download_url" field will include a link to the available file. | When the download file is generated, the "complete" field will be set to "true" and the "download_url" field will include a link to the available file. | ||
=== Status Endpoint === | |||
== Status Endpoint == | |||
stub | |||
=== Status Endpoint Example === | |||
http://csv.idigbio.org/status/<download id> (returned as "status_url" from the original download query) | http://csv.idigbio.org/status/<download id> (returned as "status_url" from the original download query) | ||
Ex. http://csv.idigbio.org/status/995ed58b-01fd-4c98-893e-e0cbdfadc8fe | Ex. http://csv.idigbio.org/status/995ed58b-01fd-4c98-893e-e0cbdfadc8fe | ||