Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Table of contents
Table of Contents | ||
---|---|---|
|
User Creation
Getting started guide:
Before you start consuming data from the API, we ask you to:
- Register as a user in DMI's Developer Portal
- Register an application in the Developer Portal and get your "API Key"
- Save the API key somewhere safe, because you need it every time you make a request for the API. Otherwise you will not be authorized by the API.
1. Register as a user
- Purpose: The goals is to get registered as a user in DMI's Developer Portal
- When you are done: You are not completely done after step 1 - you just have a user and a password. You still need to go through step 2
Step | Action | Screen dump |
---|---|---|
1.1 |
| |
1.2 |
Note: After this, you have an account in Gravitee. Don't leave the window, because you need to continue in step 2. | |
3 | Press Accept |
2. Get your API Key
- Purpose: The goal of this step is to get you "API Key", which is a password, you need every time you make a request for DMI's API. Otherwise you will not get authorized by the API.
- Other information: The API Key is linked with an application that uses the API.
- When you are done with this step: When you are done with this step, you can start using the API
Step | Action | Help |
---|---|---|
2.1 |
| |
2.2 |
|
|
2.3 |
| |
2.4 |
|
Deleting your account
If you wish to delete your user to DMI’s open API-services, please contact us by using the contact form at https://www.dmi.dk/kontakt/frie-data/ Please state that you wish to have your account deleted and specify the email of the user account.
You will receive a confirmation once your account has been deleted. Processing time can be up to 5 working days.
Find your API Key
Step | Action | Help |
---|---|---|
1 |
| |
2 |
| |
3 | Note: The system might log you automatically in. If this is the case, go to the next step. If you are not logged automatically in (and you are presented with the screenshot on the right), follow the sub-steps below:
| |
4 |
| |
5 |
| |
6 |
| |
7 |
|
Step | Action | Help |
---|---|---|
1 |
| ![]() |
2 |
|
About User Access Management
Description of the concepts of User Access Management for DMI's APIs
This section briefly introduces User Access Management for users of DMI's APIs.
DMI's Open Public Data APIs use Gravitee for User Access Management. Gravitee uses some concepts for handling user access management:
Consumer / User
When you use the API, you are a "consumer". Information about the consumer is represented in your user account with the following information:
- User type (citizen | company | government | union)
- Name (e.g. "Anders Andersen", "TV2/DANMARK A/S", "Digitaliseringsstyrelsen" or "FOA")
- CVR number (only relevant for companies or government entities)
- Business type (only relevant for companies or government entities)
- E-mail (used when you want to login to the development portal)
- Password (used when you want to login to the development portal)
Application
A consumer application is an intermediate level between a consumer and an API and is used by the consumer to subscribe to that API before being able to consume it. As a consumer, you can have several applications. An application can consume data from different APIs by subscribing to the APIs through a so-called "plan".
Plan
A plan provides a service and access layer on our API for the consumer applications. A plan specifies access limits, subscription validation mode and other configurations to meet the specific applications needs. DMI uses a simple plan for the services called "API Key Plan", which enforces verification of the consumer application's "API key" during request processing, letting only apps with approved API keys access DMI's APIs. This plan ensures that API keys are valid, have not been revoked or expired, and are approved to consume the specific resources associated with the API you subscribe to. The API key plan represents a very simple security mechanism. The purpose of requiring an API Key is to uniquely identify consumers of the API, and thus to be able to determine how different users use our API. The API plans for our APIs are free, but DMI reserves the right to revoke access for certain applications, if the Terms of Use are exceeded.
API
An API in Gravitee's terminology refers to an API Service such as for example the Meteorological Observation (metObs) service. There can be several plans for one API, but in most cases, DMI will only have a single plan for one API, since all functionality is free.
Illustration: The model below illustrates the relationship between an "Application", a "Plan" and and API.