| Table of Contents | ||||
|---|---|---|---|---|
|
This document contain access details and explains the method on how to use EHORSE-HORS' APIs.
Purpose of EHORS' APIs is to let customer' third party supplier to access customer EHORS system outside the customer premises.This serve the purpose for the third party allow 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 sending sends data to EHORS E-HORS system with EHORS our required format from existing system.
Basic Flow
The flow is simple, guest if the end user from the third party supplier needed needs to retrieve information from EHORS E-HORS system, the third party can just call a URL by providing several mandatory parameters/variables.
| draw.io Diagram | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
| Variable Name | Data Type | Sample | ExplainationExplanation |
|---|---|---|---|
| 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 |
...
Follow by default Node, and each node or sub node element can also contain 1 or more attributes.
| Node/Element/Attributes | ExplainExplanation |
|---|---|
#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
| Warning |
|---|
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. |
| Warning |
|---|
EHORS system |
...
is running on Linux based environment, thus variable name / parameter name are case-sensitive |
...
. |
Contents Pages
| Children Display | ||||||
|---|---|---|---|---|---|---|
|
...