Business API: the essentials.
- 01
Discuss the use case before the interface
Describe the workflow, source systems, countries and information needed. A business API discussion is about an agreed integration, not public access to all ONU health records. Confirm whether the required capability exists and which party is responsible for obtaining the information lawfully.
- 02
Access and documentation need confirmation
Ask ONU for current documentation, authentication, supported data fields, versioning and availability. Credentials, endpoints, throughput and service levels are set in your agreement. Use the Developer API page to prepare implementation questions, then confirm the actual supported contract.
- 03
Design around the minimum necessary data
Specify required fields and avoid requesting an entire health record when a narrow result will serve the workflow. Clarify consent, retention, deletion, logging and onward sharing. Do not place secrets or real patient records in sample requests sent through a general contact form.
- 04
Agree testing and operating responsibilities
Request a safe test environment, representative synthetic examples and acceptance criteria. Plan failure handling, retries, support and changes to the interface. A prototype’s success is not production approval; operational and data responsibilities need to be documented before launch.
Find the right way to work together.
