Communicating With PanHunter: Using The API Key
The Api Key section in the sidebar leads to the page where users can manage their API Key. API keys allow developers to access PanHunter from scripts or custom apps.
Creating An API Key
The API key page allows the creation of an API Key if no API Key currently exists. Clicking on Create New Api Key will display the newly created key exactly once, with a button to copy it to the clipboard.
Info
Make sure to record this key! The full key will not be displayed again.Displaying An API Key
The API key identifier, creation date, and delete button will be displayed. It is not possible to view the full API key: if it is lost at this point, it will be necessary to delete the current key and create a new API key.
Using An API Key
One possible application for our API keys would be connecting custom applications to PanHunter. The API Key lets developers obtain PanHunter information via its APIs. APIs exist to retrieve project and user information, or data stored in PanHunter.
The API keys are used by adding the header
X-API-KEY: <api key>
to an HTTP request made to the PanHunter API.