Category:EMD-API: Difference between revisions

From Wiki-WindPRO
Jump to navigation Jump to search
mNo edit summary
 
(60 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Intoduction ==
[[File:REST-api-diagram.png|right|thumb|350px]][[File:EMDAPI_451x303.jpg|thumb|350px|right]]
Historically, windPRO users have benefitted from easy access to the EMD online-databases – data which have been specifically developed and distributed for renewable energy purposes. With the REST (Representational State Transfer) based API’s in the EMD-API service, it is now possible to connect machine driven workflows, internal tools and services directly to more than 1Pb of high-quality climate data and other services at EMD. This page provides a brief overview on how-to access the EMD online-services through a REST-based API-access based on the [https://swagger.io/specification/ OpenAPI-standard].
== Introduction ==
Historically, [https://www.emd.dk/windpro/ windPRO] and [https://www.emd.dk/energypro/ energyPRO] users have benefitted from easy access to the EMD online-databases – data which have been specifically developed and distributed for renewable energy purposes. With the REST (Representational State Transfer) based API’s in the EMD-API service, it is now possible to connect your machine driven workflows, internal tools and services directly to more than 1Pb of high-quality climate data and other services at EMD. This page provides a brief overview on how to access the EMD online-services through a REST-based API-access based on the OpenAPI standard. Resources for the OpenAPI standard and the data model are here:


Please note: This introduction is rather technical, and aimed at programmers, modellers or analysts working with machine-driven interfaces and workflows.
* [https://swagger.io/specification/ OpenAPI-standard] - at Swagger / Smartbear
* [https://github.com/OAI/OpenAPI-Specification OpenAPI Specification and Data Model] - at GitHub.


== Get Access ==  
Please note: 
Contact the emd-sales department to obtain access: sales@emd.dk.  
* This EMD-API introduction is aimed at programmers, modellers or analysts who are working with machine-driven interfaces and workflows, typically using programming languages like [https://www.python.org/ python] or [https://www.r-project.org/about.html R].
* Also note, that we provide a number of python (jupyter notebook) samples to get you kick-started in using our API-services and to integrate towards your own services and tools.
 
== Get Help, Get Access or See Operational Status ==  
* ''Access:'' Contact the emd-sales department to obtain access: [mailto:sales@emd.dk sales@emd.dk].
* ''Help:'' Contact the EMD support hotline: [mailto:support@emd.dk support@emd.dk].
* ''Operational Status'' - at separate [[EMD-API - Operational Status|Operational Status]] wiki-page


== Authentication ==
== Authentication ==
Database-access is via an API-key approach which authenticates against a server-whitelist. Dataset users provide their login credentials (user-name and serial-key) – and the server respondswith a API-key that is then used for the authentication within the data-service API's. The API-key is personal and is never to be shared.
Database-access is via an API-key approach which authenticates against a server-whitelist. Thus, in order to access the API-services, dataset users must provide their provide their login credentials (API-key). The API-key is personal and is never to be shared.
 
== URL for API-Access ==
Data and services are accessed from the following URL: https://api.emd.dk


== Data Model ==
== URL's for API-Access and Documentation ==  
The EMD-API data services are documented in a REST based API using the [https://github.com/OAI/OpenAPI-Specification OpenAPI Specification]. The service provides the following functionality:
Data and services are accessed from the following general URL: https://api.emd.dk. Individual data and service API's are available from other wiki-pages (see also the category pages below).


== License Conditions ==
* EMD-API - Climate Data Access - [https://api.emd.dk/climate-data/ui/ OpenAPI-UI] - [[EMD-API - Climate Data Access|Wiki Page]]
At this time of writing (November 2020), this service is in beta-release. The current licencing conditions are as follows:
* EMD-API - EMD-WRF On-Demand - [https://api.emd.dk/emd-wrf-od/ui/ OpenAPI-UI] - [[EMD-API: EMD-WRF On-Demand|Wiki Page]]
* EMD-API - Global Atlas Service - [https://api.emd.dk/global-atlas-service/ui/ OpenAPI-UI] - [[EMD-API_-_Global_Atlas_Services|Wiki Page]]
* EMD-API - Global Wind Energy Index Service - [https://api.emd.dk/wind-index/ui/ OpenAPI-UI] - [[EMD-API - Wind Energy Index Service|Wiki Page]]


API access is currently provided as an addition to the services provided for our windPRO and energyPRO users. As such, the general EMD license conditions apply - see [https://www.emd.dk/files/windpro/UK-LicenseAgreement_2019.pdf pdf-here]. For our API-users, the license conditions are amended with the following:
== Dataset Acknowledgement ==
API-subscribers must clearly acknowledge EMD and its data providers as the source of data in any private or public disseminations: For details on how-to provide the attribution see the individual climate-dataset documentation pages at the online-data wiki: https://help.emd.dk/mediawiki/


'''Conditions for EMDAPI-Users''':<br>
== EMD-API Credits ==
API access to EMD online-databases are restricted to users who have been granted or have purchased the EMDAPI-access subscription. API-users are granted a license to use the data, combine the data with other products, copy the data and distribute the data in a modified form - also as a part of a commercial re-licensing. The data can be used as a part of an application or service. The following restrictions apply: Data downloads are unlimited – however a fair use policy apply. Multiple, simultaneous download-streams are not allowed. It is not allowed to re-sell or re-distribute the data in an unmodified form (where the original numerical values in the dataset are left unmodified). EMD must be notified of and approve in writing any commercial data-service offerings with re-licensing aimed at 3rd-parties. API-subscribers must clearly acknowledge EMD and its data providers as the source of data in any private or public disseminations: For details on how-to provide the attribution see the individual climate-dataset documentation pages at the online-data wiki: https://help.emd.dk/mediawiki/
The EMD-API has been developed as a part of the [https://www.recastproject.dk RECAST] project. RECAST is a joint R&D project with participants from the wind energy industry and academia: [http://www.emd.dk/ EMD], [https://www.vestas.com/ Vestas], [https://www.res-group.com RES] and [https://www.dtu.dk DTU]. The RECAST project is co-funded by the Innovation Fund Denmark.

Latest revision as of 07:55, 24 May 2023

Introduction

Historically, windPRO and energyPRO users have benefitted from easy access to the EMD online-databases – data which have been specifically developed and distributed for renewable energy purposes. With the REST (Representational State Transfer) based API’s in the EMD-API service, it is now possible to connect your machine driven workflows, internal tools and services directly to more than 1Pb of high-quality climate data and other services at EMD. This page provides a brief overview on how to access the EMD online-services through a REST-based API-access based on the OpenAPI standard. Resources for the OpenAPI standard and the data model are here:

Please note:

  • This EMD-API introduction is aimed at programmers, modellers or analysts who are working with machine-driven interfaces and workflows, typically using programming languages like python or R.
  • Also note, that we provide a number of python (jupyter notebook) samples to get you kick-started in using our API-services and to integrate towards your own services and tools.

Get Help, Get Access or See Operational Status

Authentication

Database-access is via an API-key approach which authenticates against a server-whitelist. Thus, in order to access the API-services, dataset users must provide their provide their login credentials (API-key). The API-key is personal and is never to be shared.

URL's for API-Access and Documentation

Data and services are accessed from the following general URL: https://api.emd.dk. Individual data and service API's are available from other wiki-pages (see also the category pages below).

Dataset Acknowledgement

API-subscribers must clearly acknowledge EMD and its data providers as the source of data in any private or public disseminations: For details on how-to provide the attribution see the individual climate-dataset documentation pages at the online-data wiki: https://help.emd.dk/mediawiki/

EMD-API Credits

The EMD-API has been developed as a part of the RECAST project. RECAST is a joint R&D project with participants from the wind energy industry and academia: EMD, Vestas, RES and DTU. The RECAST project is co-funded by the Innovation Fund Denmark.

Retrieved from "http://help.emd.dk/mediawiki/index.php?title=Category:EMD-API&oldid=15293"