Difference between revisions of "API keys"
Jump to navigation
Jump to search
| (21 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | This document can now be found at its new location in the [https://docs.hornbill.com/esp-config/integration/api-keys/ Hornbill Document Library]. | |
| − | + | ||
| − | + | [[file:hornbill-document-library.png|API Keys|link=https://docs.hornbill.com/esp-config/integration/api-keys/]] | |
| − | { | + | |
| − | + | <!-- | |
| − | + | {{breadcrumb|[[Main Page|Home]] > [[Configuration]] > [[Platform Configuration]] > [[Users]] > [[User Account]] > API Keys|Configuration}} | |
| + | {{Section| | ||
==Introduction== | ==Introduction== | ||
An API key is typically used in conjunction with one of Hornbill's import utilities to avoid the need to specify passwords in configuration files that will be located outside of Hornbill. Each of the Hornbill import utilities must perform their actions in the context of a user account and in order to do this an API key must be created. | An API key is typically used in conjunction with one of Hornbill's import utilities to avoid the need to specify passwords in configuration files that will be located outside of Hornbill. Each of the Hornbill import utilities must perform their actions in the context of a user account and in order to do this an API key must be created. | ||
| − | It is good practice to create and use API keys in conjunction with bespoke development work and integration with other systems that involves information being passed into your Hornbill instance ''from'' these other systems. | + | It is good practice to create and use API keys in conjunction with bespoke development work and integration with other systems that involves information being passed into your Hornbill instance ''from'' these other systems.| |
| − | + | {{rightBox|Related Articles| | |
| − | |||
| − | |||
| − | | | ||
| − | | | ||
| − | |||
| − | |||
:* [[Users]] | :* [[Users]] | ||
:* [[Hornbill Open Integration Tools]] | :* [[Hornbill Open Integration Tools]] | ||
:* [[API_Endpoint|Finding your API endpoint]] | :* [[API_Endpoint|Finding your API endpoint]] | ||
| − | |} | + | :* [[Hornbill_Solution_Center#Support|Support Passcode]] |
| − | + | }} | |
| + | }} | ||
| + | {{Section| | ||
==Creating and Managing API Keys== | ==Creating and Managing API Keys== | ||
| − | Since any API key is tied to a Hornbill | + | [[File:userAPIkey.PNG|right|500px|link=https://wiki.hornbill.com/images/6/65/UserAPIkey.PNG]] |
| − | + | Since any API key is tied to a Hornbill User, to create one, navigate to the user profile under Platform Configuration. Once the user profile is displayed then navigate to the '''API Keys''' tab. | |
| − | |||
| − | |||
<br> | <br> | ||
<br> | <br> | ||
| + | ===Creating an API Key=== | ||
Click on the + button to start creating a new API key. | Click on the + button to start creating a new API key. | ||
| − | [[File:createUserAPIkey.PNG| | + | [[File:createUserAPIkey.PNG|400px|right|link=https://wiki.hornbill.com/images/e/ed/CreateUserAPIkey.PNG]] |
:* '''Description''' | :* '''Description''' | ||
:: This is a simple description of the API key that is being created | :: This is a simple description of the API key that is being created | ||
| Line 43: | Line 39: | ||
:: <b>session:*</b> - will allow any API in the session service | :: <b>session:*</b> - will allow any API in the session service | ||
:: <b>session:getSessionInfo</b> - will allow this API | :: <b>session:getSessionInfo</b> - will allow this API | ||
| − | :: <b>session:get*</b> - will allow any API whos name starts with ' | + | :: <b>session:get*</b> - will allow any API whos name starts with 'get' in the session service |
::<br> | ::<br> | ||
:: <b>apps/com.hornbill.core/*</b> will allow all com.hornbill.core defined API's | :: <b>apps/com.hornbill.core/*</b> will allow all com.hornbill.core defined API's | ||
| Line 53: | Line 49: | ||
<br> | <br> | ||
Click on the "Create" button to finish creating the new API key. | Click on the "Create" button to finish creating the new API key. | ||
| + | |}} | ||
| + | {{TOP}} | ||
| + | [[Category:Configuration]][[Category:How To - Integration]] | ||
| − | + | <!-- http://localhost:3000/esp-config/integration/api-keys --> | |
| + | [[Category:HDOC]] | ||
Latest revision as of 18:04, 10 April 2024
This document can now be found at its new location in the Hornbill Document Library.
