User Tools

Site Tools


leon:api-keys

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
leon:api-keys [2019/07/08 09:07]
rafal
leon:api-keys [2022/09/07 14:52] (current)
marek
Line 1: Line 1:
 ====== API Keys ====== ====== API Keys ======
-[{{ :leon:updates:API key add.png?200|Creating of the API Key}}]+[{{ :leon:settings:api-keys:api1.png?200|Creating of the API Key}}]
 [{{ :leon:updates:API key.png?200|Generated API Key - store safe}}] [{{ :leon:updates:API key.png?200|Generated API Key - store safe}}]
  
-**API Keys** panel allows accessing Leon API from the interface in order to obtain feed of different kinds of data from Leon for the purpose of outside integrations. +**API Keys** panel allows accessing Leon API from the interface in order to obtain feed of different kinds of data from Leon for the purpose of outside integrations. 
  
-The functionality generates a **Refresh Token**, which is a special kind of token that can be used to obtain a renewed access token which allows programmatically accessing a protected resource. Access tokens are attached to API request. More information can be found in the documentation (https://bitbucket.org/leondevteam/api-documentation/src/master/).+The functionality generates a **Refresh Token**, which is a special kind of token that can be used to obtain a renewed access token which allows programmatically accessing a protected resource. Access tokens are attached to API request. More information can be found in the documentation (https://apidoc.leonsoftware.com/).
  
 The token can be generated only by admins in Settings -> API keys page.  The token can be generated only by admins in Settings -> API keys page. 
Line 14: Line 14:
    - Enter the name and the description of the integration    - Enter the name and the description of the integration
    - Select resources which can be accessed by using the token    - Select resources which can be accessed by using the token
 +   - Select the **aircraft(s)** for which the data should be exported. If a specific aircraft isn't selected, it will be assumed that the API key applies to the whole fleet
    - Click the {{:leon:updates:generate key button.png?nolink&100|}} button    - Click the {{:leon:updates:generate key button.png?nolink&100|}} button
    - Copy generated key and store it safely    - Copy generated key and store it safely
Line 19: Line 20:
 It is also possible to **edit existing 'API Keys'** and update the Name, Description and Resources. It is also possible to **edit existing 'API Keys'** and update the Name, Description and Resources.
  
-<box>**Please remember that once the token is generated it MUST be stored safely as it cannot be retrieved after the pop-up window is closed.**</box>+<box>**Please remember that once the token is generated it MUST be stored safely as it cannot be retrieved after the pop-up window is closed. As a suggestion, once you have key you can copy/paste it in the 'Description' box.**</box>
  
leon/api-keys.1562576865.txt.gz · Last modified: 2019/07/08 09:07 by rafal