Welcome to TERN Knowledge Base
Creating API Keys
API keys are used to connect to TERN API endpoints from the user’s custom applications (or by using simple tools such as Curl, or WGET, or any of the TERN API Swagger Dashboards) to get/download TERN data the user is interested in. All requests made from custom applications must include the API key in the Authorization section of the header of each request.
Learn about what an API is here
How to get a TERN API Key
To generate an API Key, please visit the TERN Account portal at (https://account.tern.org.au) and Sign In. After Sign In, follow the steps below:
API Keys have an expiry period! TERN API Keys last a period of 12 months. After generate an API Key, the API Key Information screen (see Figure 2 below) displays the Key expiration date. Please take note of this date so that you can generate a new API Key just before the expiry date of the current one.
Steps
In the menu on the left, click Create API key menu link (1)
Enter the name of the API key in the API key name field (can be arbitrary, for your records - but it's mandatory) (2)
Click the button Request API Key (3)
Copy the generated API key in the API key field (4)
After generating the API key, copy the key and store it in a secure place (Note: The API key is only displayed once in the API Key Information page [see figure 2 above] - and will not be shown or accessible after this - for security reasons). if you lose the API Key you need to generate a new key.
For information on how to use API Keys, please refer to Using API Keys to Access TERN Data Services.
Next Page: Managing API Keys
Provide your feedback about the experience with Knowledge base