HINLINK: Access HIN data using API
Authorized HIN licensees may access the HIN data using HIN Application Programming Interface (HINAPI) Service or HINLINK to provide real-time HIN database integration with existing user systems and applications.
The HINAPI or HINLINK will fill that need by providing a pathway for direct integration into existing internal systems, automating the HIN updating process, and allowing users to adapt HIN to their specific business needs.
For example, the HINAPI or HINLINK can be used to:
- Retrieve HIN information, status, class of trade or market segment, etc.
- Automate HIN daily or weekly updates;
- Determine if a HIN has been enumerated for a particular facility; and
- Validate if your trading partner is an active HIN licensee;
The HINAPI or HINLINK will save time spent on validation and other HIN activities. Integrating HINAPI or HINLINK into workflows will allow applications to publish HIN content automatically on a real-time basis by directly pulling data from our database servers.
HIN API Endpoints and Authentication
All HIN APIs shall be sent as HTTP GET with Basic Authentication to our endpoint URL.
HTTP Request Method: GET
Base URL: https://api.hibcchin.org/
JSON Content-Type: application/json
All calls to the HIN database API require a HIN database license and API access authentication. The credentials must be submitted as a header to your HTTP Request method. All responses will be in JSON format.
For more information, contact us.
