...
This document is aimed at developers and implementers of the systems involved. It should cover enough detail to allow a developer to fully implement transaction endpoints in the required system.
Security
All RESTful endpoint of the External API will be secured using HTTPS and basic auth.
Error Messages
In the cases in which a transaction fails the standard HTTP response codes will be used to convey these error. In some cases a more detailed error is needed. These endpoint will return a XML document representing the error in the HTTP body. The document will have the following structure:
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0" encoding="UTF-8" ?>
<error>
<error_code>...</error_code>
<error_msg>...</error_msg>
</error> |
External API
API exposed by HIM (interoperability layer) to PoS systems. This part of the API is used by systems like OpenMRS and RapidSMS to interact with the Rwandan HIE. This API will be available publically (for system with the the correct privileges). To see more information about how to access this API see: RHEA Published API Specifications
...
Terminology Service
Security
All RESTful endpoint of the External API will be secured using HTTPS and basic auth.
Error Messages
In the cases in which a transaction fails the standard HTTP response codes will be used to convey these error. In some cases a more detailed error is needed. These endpoint will return a XML document representing the error in the HTTP body. The document will have the following structure:
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0" encoding="UTF-8" ?>
<error>
<error_code>...</error_code>
<error_msg>...</error_msg>
</error> |