...
| draw.io Diagram | |||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
The flow is simple, guest from third party supplier needed to retrieve information from EHORS system, third party can just call a URL by providing several mandatory parameters/variables.
Basic Requirement
| API Service URL | https://api.ehors.com/ |
| Data Request Method | POST |
| Data Format Charset | UTF-8 (General) |
| Data Respond Format from EHORS | XML Generic |
MUST have Parameters/Variables
| Variable Name | Data Type | Sample | Explaination |
|---|---|---|---|
| accessID | String (255) | ABC123 | Unique key per customer' property, it'll link to particular site of the customer' property EHORS system, Meaning 1 property will need 1 accessID |
| accessKey | String (255) | ABC123 | Combination of accessID to allow access to the EHORS system, its like a "username" and "password" |
| moduleCode | String (255) | ModuleABC | A code from EHORS' APIs authorized module access, this can be combined with the different property have different access of modules. Read more |
| command | String (255) | G_ABC_AA | Command designed in EHORS' APIs to map function or script called in customer' EHORS system |
EHORS APIs Respond XML Format
...
Follow by default Node, and each node or sub node element can also contain 1 or more attributes.
| Node/Element/Attributes | Explain |
|---|---|
#SCRIPT_RESULT | Root XML node |
#SCRIPT_RESULT/RESULT | Result of the API call respond data retrieved by API from customer EHORS system |
#SCRIPT_RESULT/SCRIPT_STATUS | General Status of SUCCESS transactions or NON-SUCCESS transactions, refer to NON-SUCCESS reference |
#SCRIPT_RESULT/ERROR_MESSAGE | Only show when the #SCRIPT_RESULT/SCRIPT_STATUS is NON-SUCCESS, and it may contain RAW URL ENCODED format of message |
Limitations / Throttle Control
...