Difference between revisions of "EMD-API - Global Atlas Services"

From Wiki-WindPRO
Jump to navigation Jump to search
Line 24: Line 24:
 
* ''Coverage'': Check if a particular dataset has coverage at a certain location
 
* ''Coverage'': Check if a particular dataset has coverage at a certain location
 
* ''Download'':  Request to download data for a certain location. Typically, the interface provides the possiblity to download the data in various formats.
 
* ''Download'':  Request to download data for a certain location. Typically, the interface provides the possiblity to download the data in various formats.
 +
 +
== Client Software Other Languages and Tools ==
 +
REST and OpenAPI is easily consumed from a lot of software tools. It is perfectly possible that your preferred language is supported. OpenAPI works well with languages such as - but not limited to - C#, R, python, java, php, scala and swift. Just download the YAML or JSON service description and use the [https://editor.swagger.io/ Swagger Editor] or [https://github.com/OpenAPITools/openapi-generator OpenAPI Generator] to generate the client libraries for your preferred software. Then you are ready to integrate towards your preferred systems and workflows.
 +
 +
To generate the client libries yourself - one possible process is to:
 +
 +
# Download the OpenAPI (openapi.yaml or openapi.json) description files - [https://api.emd.dk/climate-data/openapi.yaml here-yaml] or [https://api.emd.dk/climate-data/openapi.json here-json]
 +
# Load it into the swagger editor - [https://editor.swagger.io here]
 +
# Choose to "Generate Client" from the drop-down menu within the swagger editor.

Revision as of 18:09, 7 February 2021

Introduction

EMDAPI 451x303.jpg

The Global Atlas Services is available from the EMD-API: It is a service created in order to provide an interface (REST/OpenAPI standard) to atlas-data on wind-resources, siting-data (such as site flow characteristics), geospatial-predictors and elevations. The service delviers a unitified interface to a wide range of atlas data, and has the following key features:

  • Instant data delivery: All datasets within the EMDAPI are ready processed and requests are served within seconds or minutes
  • Hundreds of atlas parameters for renewable energy: EMDAPI provides access to hundreds of parameters on winds, siting, elevations and other geospatial parameters used within renewable energy
  • Unified interface: The unified interface which allows for integration to internal processes and tools
  • Trusted datasets: EMDAPI builds upon the trusted data-bases and data-sources is also used through the online-data services in windPRO, some for more than a decade.
  • Built on open standards: EMDAPI is a REST based service that implements the OpenAPI standard].
  • Available from any development tool: Access to the climate databases is available from your preferred development platform - C#, R, python, html, java, php, scala and swift. Just use the OpenAPI tools to generate the client software for your preferred platform.

Access

The API is currently (February 2020) in alpha-release. To see more documentation and to access the data-services, please visit the API through the following URL's:

  • EMD-API Overview (Wiki) - here.
  • EMD-API Main Page (API) - here.
  • EMD-API Global Atlas Service UI (API) - here.

Any technical questions on our global atlas service can be addressed to our Senior Technical Specialist - Morten Lybech Thøgersen: mlt@emd.dk.

Data Model - Global Atlas Service

The EMD global-atlas-services is documented in a REST based API using the OpenAPI Specification. You can view the interfaces and download the interfaces as json or yaml, here. The service provides the following functionality:

  • Datasets: List of available datasets with their ID’s, descriptions and documentation liks (URL's)
  • Coverage: Check if a particular dataset has coverage at a certain location
  • Download: Request to download data for a certain location. Typically, the interface provides the possiblity to download the data in various formats.

Client Software Other Languages and Tools

REST and OpenAPI is easily consumed from a lot of software tools. It is perfectly possible that your preferred language is supported. OpenAPI works well with languages such as - but not limited to - C#, R, python, java, php, scala and swift. Just download the YAML or JSON service description and use the Swagger Editor or OpenAPI Generator to generate the client libraries for your preferred software. Then you are ready to integrate towards your preferred systems and workflows.

To generate the client libries yourself - one possible process is to:

  1. Download the OpenAPI (openapi.yaml or openapi.json) description files - here-yaml or here-json
  2. Load it into the swagger editor - here
  3. Choose to "Generate Client" from the drop-down menu within the swagger editor.