The EcoPlots API (application programming interface) provides machine-readable search and download endpoints to support the discovery and access of ecological plot data. The EcoPlots API feeds directly from the most updated available version of the different datasets that TERN has available. The data is updated often, so the dataset you access via the API today might vary from future versions of the same dataset.
All API endpoints need a system generated API Key to access and retrieve data. Users can create API Key by visiting their TERN Account.
Using the Portal vs the API
Broadly speaking, data discovery is much easier using the search filters within the https://ecoplots.tern.org.au/. The API is most useful for assisting with projects that require data to be constantly updated.
Web interface
Searches performed using the EcoPlots web interface are a snapshot of the data in time.
Searches performed using the web interface then downloaded using the “data download” feature are most suitable for researchers who need a persistent dataset that can be used for reproducible research. Once a dataset has been created using search filters, download the data to your personal TERN account using the “download dataset” feature. Then mint a DOI (Digital Object Identifier) for the package containing that exact version of the dataset so that it becomes persistent and reproducible.
API
The API is directly accessing the latest version of TERN datasets. For that reason, it is best suited for use in a script that runs daily.
An example of use is our association with the Atlas of Living Australia. The ALA plant occurrence data is pulled from EcoPlots at intervals and published to the ALA website using one of the API endpoints.
More information
This EcoPlots API eSupport user guide is aimed towards more technical users. If you require further information, we recommend visiting the links below.
Visit this Web APIs and Endpoints page to get a general overview of APIs and their usage.
The https://ecoplots.tern.org.au/api/v1.0/ui- includes specific EcoPlots API and technical documentation.
If you require further assistance with your project that is using TERN’s EcoPlots API, please contact esupport@tern.org.au with your query.
0 Comments