Difference between revisions of "API keys"

From Hornbill
Jump to navigation Jump to search
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{breadcrumb|[[Main Page|Home]] > [[Administration]] > [[System Administration|System]] > [[Organisational Data]] > [[Users]] > [[User Account]] > API Keys|Administration}}
+
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|
 
{{Section|
 
==Introduction==
 
==Introduction==
Line 8: Line 13:
 
:* [[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]]
 
}}
 
}}
 
}}
 
}}
Line 18: Line 24:
 
===Creating an API Key===
 
===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|400px|right]]
+
[[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 33: 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 'api' in the session service
+
:: <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 45: Line 51:
 
|}}
 
|}}
 
{{TOP}}
 
{{TOP}}
[[Category:Administration]][[Category:How To - Integration]]
+
[[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.

API Keys