This document explains the method on how to use E-HORS' APIs.
E-hors will provide the access details allowing the third party to access the E-hors system. Once you have given the access, it will allow you to retrieve limited data and sends data to E-HORS system with our required format from existing system.
Basic Flow
The flow is simple, if the end user from the third party supplier needs to retrieve information from E-HORS system, the 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 | Explanation |
|---|---|---|---|
| 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
In General EHORS API will reply / respond with XML generic format as follow:
<?xml version="1.0" encoding="utf-8"?> <SCRIPT_RESULT> <RESULT> ... RESULTS WILL SHOWN HERE ... </RESULT> <SCRIPT_STATUS>SUCCESS</SCRIPT_STATUS> </SCRIPT_RESULT>
<?xml version="1.0" encoding="utf-8"?>
<SCRIPT_RESULT>
<SCRIPT_STATUS>FAILED</SCRIPT_STATUS>
<ERROR_MESSAGE> ~ FAILED MESSAGE HERE ~ </ERROR_MESSAGE>
</SCRIPT_RESULT>
XML Format Explain
EHORS XML are generic format, you may also refer to following reference. We have a generic header which always start as following
<?xml version="1.0" encoding="utf-8"?>
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
EHORS' API do have a simple limitations by NOT calling the URL from the same IP address within 2 seconds. Thus third party script MUST have control of the resting period of at least 1 second before calling next command.
EHORS system is running on Linux based environment, thus variable name / parameter name are case-sensitive.