IDigBio API: Difference between revisions

no edit summary
No edit summary
 
Line 31: Line 31:
== iDigBio APIs ==
== iDigBio APIs ==


There are several APIs you can use to retrieve data from iDigBio:
There are several APIs you can use to retrieve data from iDigBio: Search, Download, Record, and Media.
 
# Search API
# Download API
# Record API


=== Search API ===
=== Search API ===
Line 49: Line 45:
For a detailed discussion of the data included in one of our downloads, you can read our [https://www.idigbio.org/content/understanding-idigbios-data-downloads Understanding iDigBio's Data Downloads] blog post.
For a detailed discussion of the data included in one of our downloads, you can read our [https://www.idigbio.org/content/understanding-idigbios-data-downloads Understanding iDigBio's Data Downloads] blog post.


=== Record API ===
=== Record & Media APIs ===


The record API is of limited use for most people outside iDigBio. It is intended to return a single record's unprocessed information. You must know the iDigBio record identifier to be able to request a record from this API. The significant additional functionality this API provides is access to prior versions of records stored in iDigBio. Other APIs only interact with the most recent record version.
The record and media APIs are of limited use for most people outside iDigBio. They are intended to return a single specimen or media's unprocessed information. You must know the iDigBio record or media identifier to be able to request data from this API. The most common use of the media API is to retrieve a link to an image as stored at iDigBio from a media record identifier. The significant additional functionality the record API provides is access to prior versions of records stored in iDigBio. Other APIs only interact with the most recent record version.


'''ToDo:''' Make documentation for v2 of this API publicly accessible.
'''ToDo:''' Make documentation for v2 of this API publicly accessible.
82

edits