82
edits
IDigBio API: Difference between revisions
no edit summary
No edit summary |
|||
| Line 61: | Line 61: | ||
The iDigBio [https://www.idigbio.org/portal/search Portal Search page] map is also provided as a stand-alone module for use in any third-party web site. If you are a software developer interested in integrating this map, please see the [https://github.com/iDigBio/idb-portal/blob/master/README.md#stand-alone-map-module-use documentation on Github] provided as part of the portal source code. | The iDigBio [https://www.idigbio.org/portal/search Portal Search page] map is also provided as a stand-alone module for use in any third-party web site. If you are a software developer interested in integrating this map, please see the [https://github.com/iDigBio/idb-portal/blob/master/README.md#stand-alone-map-module-use documentation on Github] provided as part of the portal source code. | ||
= | === Client Libraries === | ||
== Client Libraries == | |||
Client libraries, packages, and modules are pieces of software that make it easier to interface with the iDigBio API. | Client libraries, packages, and modules are pieces of software that make it easier to interface with the iDigBio API from a specific programming language. We have developed and maintain libraries for the following languages: | ||
=== ridigbio R Package for Search API === | === ridigbio R Package for the Search API === | ||
R is a free software environment for statistical computing and graphics. It compiles and runs on a wide variety of UNIX platforms, Windows and MacOS. | R is a free software environment for statistical computing and graphics. It compiles and runs on a wide variety of UNIX platforms, Windows and MacOS. | ||
| Line 102: | Line 89: | ||
The iDigBio Python library is an "official" client library in the iDigBio code repository. | The iDigBio Python library is an "official" client library in the iDigBio code repository. | ||
=== idigbio_client Ruby Gem === | === idigbio_client Ruby Gem for the Search API === | ||
The idigbio_client ruby gem is available: | The idigbio_client ruby gem is available: | ||
| Line 119: | Line 106: | ||
If you are in need of other client libraries or iDigBio API features, please use the [https://www.idigbio.org/modal_forms/nojs/contact feedback button] to submit your request. | If you are in need of other client libraries or iDigBio API features, please use the [https://www.idigbio.org/modal_forms/nojs/contact feedback button] to submit your request. | ||
== Specification == | |||
The [https://github.com/idigbio/idigbio-search-api/wiki iDigBio API v2 / iDigBio Search API specification] includes detailed information about the Search API endpoints, parameters, query format, values, and returns. It is available in the github wiki associated with the [https://github.com/iDigBio/idigbio-search-api code repository]. The iDigBio Search API was released to production in June 2015. | |||
iDigBio transitioned from version 1 to version 2 (v1 to v2) of the API. All v1 endpoints and documentation should be considered deprecated, even if they continue to function. Programmers who are interested in accessing data directly in iDigBio via an API should consult the v2 API documentation. '''The v2 API is also known as the iDigBio Search API.''' | |||
The now-deprecated [[iDigBio API v1 Specification]] includes detailed information about the old v1 API endpoints, parameters, values, and returns. In most cases, the only reason to use the v1 API was to retrieve raw, unprocessed versions of a record (e.g. no iDigBio data quality enhancements) or to access previous versions of a particular record. | |||
== Examples == | |||