Health Product Declaration Collaborative (HPDC) and Healthy Building Network (HBN) are excited to announce that on August 1, 2017 we launched a great new feature - an API (Application Program Interface) which will allow product data you have entered in the HPD Builder to be exported into Portico, and vice versa. We know you have been waiting for this capability, and appreciate your patience!
What is an API? API stands for "Application Program Interface." It is a set of routines, protocols, and tools for building software applications. An API specifies how software components should interact. In this case, it specifies how Portico and HPD Builder can share data from one system to the other.
What the Portico-HPD Builder API does: It is first important to understand that this is an optional feature for manufacturers and 3rd-party preparers who have both Portico and HPD Builder accounts. Before using the API you will need to add permissions to both accounts, which signal to the applications that you have authorized your data to be transmitted. Instructions for how you will establish the API connection between your Portico and HPD Builder accounts, which require API tokens/keys to be generated and exchanged, are available by clicking the button below.
The API imports product data you've entered in the HPD Builder into the corresponding fields in Portico (and vice versa) saving you the time it would take to reenter all of your products a second time into a second database. The API functionality allows you to select the product record that you wish to import data into, and then match it with the corresponding record in the other system. The import request is activated on user request - it's not automatic - and is done one product at a time, so that you have full control over when and how your product data is shared. A user must already have established an account in both systems, and established the permissions to authorize data transmission, in order to use the API feature. You cannot import data from Portico into the Builder, if you don't already have a Builder account, and vice versa.
What it does not do: The API does not
- Bulk upload
- Share data automatically
- Allow you to print or publish an HPD from Portico. If you wish to print or publish an HPD with data that you originally entered in Portico, first import that data into your HPD Builder account, and then publish as you normally would from HPD Builder.
How do I use it? Below you will find a link to a downloadable PDF with detailed instructions on how to use the API.
Please Note: The HPD Builder will be transitioning from the 2.0 Standard to the 2.1 Standard on August 1st. At that time, you will be able to upgrade existing 2.0 product records to the 2.1 format and all new work will be done in the 2.1 format. Any HPD published from HPD Builder 2.1 will be in the 2.1 format. Although you will no longer be able to work on HPDs in the 2.0 format in the Builder, you will be able to import either 2.0 or 2.1 records into Portico via the API.
What if I have questions? If you have questions about the API please contact HBN support at support@healthybuilding.net, and we will respond shortly.