| Manage API Keys v1.0 – Allows a user to create and manage API keys for use in API authentication. (Toggled off) In V1 Healthcode world, we suffer through a lot of manual overhead managing what we know today as a ‘Web Service Username’ and ‘Web Service Password’. These are manually generated by Healthcode staff, then copied into V1 Admin, then the user retrieves this through their Healthcode account and copies into their PAS/PMS system. In our new V2 world, for any of our newly developed APIs, we will move to an ‘API Key Id’ and ‘API Key’. These can be created by the customer/user entirely self-serve via their Healthcode account with no intervention from Healthcode staff. The first APIs to use this will be ICE when it launches later this year. API Key Name: This is user defined. Can be anything the user would like to use. API Key Id: This is auto generated. It is the API Key Name, lowercase and spaces removed, with the users Account Id prefixed. API Key: This is an auto generated string of characters. Both the ‘API Key Id’ and ‘API Key’ are used when calling our new APIs to authenticate the user. This is detailed in our API documentation. If an API Key is deleted, it can no longer be used for authentication. It cannot be recovered. The user would need to create a new API Key. You must be an account manager to see this new screen. |
