Updated PBS API website documentation

Page last updated: 19 Nov 2024

Updated PBS API web pages

The PBS API web pages have been relocated from the HPP to the Developers site to help users find the information they need. The content has been reviewed and updated accordingly. On the right of the new API page you can find links to the Embargo API, Public API and FAQ pages. At the bottom of the main API page is the Resources section which contains relevant documents, such as the Data Dictionary, Data Model, etc.

Updated Guide - ‘PBS API V3 - File Mapping Generation Process v3.0’

This document is to assist users to recreate the PBS Text files (PBS TXT Extracts) from the data available via the PBS API Version 3.  It may also be useful for non-text file users to help identify data relationships. The updated document can be found in the Resources section of the new API page.

Please Note: The Department does not endorse the PBS Text files (PBS TXT Extracts) currently released as they are no longer fit for purpose. The Department encourages Software vendors to include the many updated PBS policy and legislative concepts that are now available.

Updated embargo API user renewal process

Embargo API access credentials expire annually for organisations based on the anniversary of the first application for access.

Organisations will receive a correspondence 45 days before the upcoming expiry of the Embargo API access with a call to action to confirm which existing users need to retain access to the Embargo API. If the organisation responds within 15 days, their access will be renewed automatically and they will not need to re-apply for renewal via the Health Products Portal (HPP). 

The new Client Secret for Embargo API Access will be shared with organisations via another correspondence. The new Secret will be valid for 12 months from the old Secret expiry date and will need to be updated for all individuals. Organisations can update their system with a new Secret anytime until the old one expires. 

If the organisation does not respond within 15 days, their access will expire. They will need to reapply via the HPP. 

Further details and screenshots of this process have been added to the API FAQ page under the heading 'When do my API access credentials expire?'