Advanced Html & API Properties
If you wish to use "Google Analytics" or any other 3rd party service, with Hyper Web-App, you need to inject some JS code into page Header and Body.Use Website Content on hyper client app, to setup these HTML segments:
| Content ID | Usage Description |
|---|---|
| Page_Header_Code | Stream out any code just before the closure of the html header, just before </head> <body> . |
| Page_Body_Code | Stream out any code at the end of the html body, just before </body> </html> . |
Please note: Segments will be injected (included on the html file) only when the user is entering a page.
When posting a form or refreshing the same page address, these contents will NOT be injected.
Do not add language suffix (like "_eng") to these records.
In case of complex integration (e.g. Facebook + G.Analytics + custom leads management), We recomend you to create your own custom .js file with all scripts needed for manipulating page data / cookies etc.
Use the Page_Header_Code / Page_Body_Code to load necessary libraries and execute your "base function".
We are not teaching code here.... so just for example:
you can get current page address by using window.location.pathname, for this page it will return "/kb_page1088".
for Accessibility Tools
Use these record keys to inject code Permanently, even after post / refresh:| Content ID | Usage Description |
|---|---|
| Page_Permanent_Header_Code | Stream out any code just before the closure of the html header, just before </head> <body> . |
| Page_Permanent_Body_Code | Stream out any code at the end of the html body, just before </body> </html> . |
Session Properties
Hyper session data can be passed in Http Header, Http Post (url encoded), Http Get or Json fields (in main object).| Field Name | Description |
|---|---|
| SessionID |
Unique key as 24 chars string. Usually passed by "HyperSession" cookie, but can be passed as field (Http Get/Post/json).
We use standard HTTP session cookie (without "Expires" / "Age" attributes). |
| UI_Lang |
On projects with multi language installed, You can ask for UI language other then the default, by passing 3 letters code:
ENG, HEB, RUS, ARA, SPA, FRA, HIN, CHI. Pass only one language at a time. Lang code (value) is case sensitive ! Use this field freely, you can switch language during a session for both Html and API. |
| Authorization |
Only for API instance (domain), Only as HTTP Header. simple string [0-9,a-z,A-Z,_], length 120 chars.
Need to contain the Access Token for all functions beside "RefreshToken". Here is an example of the Http header:
Authorization: Bearer azYDfEItGJ435VXdLPV5PWicfNcnKLjBBk0tGFBZ4enpyCYXWNVx9fXSTkbApDr49d18LWHhJf84b125Sj28Z3QqimAM6iqGad63Fy2-cjtwSls1d7ThgF2J
* Too many calls without this header, will activate the self defense algorithms (Ban IP address).
|
| User-Agent | Common HTTP Header: used by hyper web-app to Render Html to Desktop or Mobile device. |
| Cookie | Common HTTP Header: used by hyper web-app to analyse 3rd party cookies and Extract data to the CRM. |
| Boundary | Common HTTP Header: used in "MultiPart Form" when uploading files both in HTML and API modes. |
The HTTP folder
Relative to "Hyper_Website_API.exe" path, you will find a Sub folder named "HTTP", managed by the web-app !SYE HTTP server will read these files from disk (serve them to browsers): css, js, fonts and media files.
Let us describe each folder's content and management:
| Folder Name | Description |
|---|---|
| CSS |
Contain css files, fonts, and images for the UI buttons.
Do NOT change this content! It is part of the Hyper web app and managed by SYE software. |
| JS |
Javascript files. We are using jQuery libraries that comes with it's own css and image files.
The file "sye.js" contain the code from SYE software for the UI logics. Do NOT change this content! It is part of the Hyper web app and managed by SYE software. |
| Media |
Client media (logo, menu buttons, styling etc) is stored on this folder.
You can change the image files in this folder and add your own. Only after installation (once), the file "Http_New_Setup.zip" will be extracted into this folder. These are the Default media files from SYE software. from that point you can modify it. |
| Media\CSS |
Client custom css for changing the HTML design. Create only the files you need.
These are the possible file names:
Custom_LTR.css Custom_LTR_Mobile.css
Custom_RTL.css Custom_RTL_Mobile.css Text direction by user language: LTR = Left to Right; RTL = Right to Left; Desktop is the default; Mobile when browser details (user agent) are from Android / iOS. |
| Media\JS |
Client custom javascript for changing the HTML UI logics, OR adding animation etc. File name should be custom.js and you can loan any other js library from it. |
| EMail Body Related Images |
This folder will be created automatically by the web-app on the first time you run it. Any file you place here will be attached to Outgoing mail messages, IF the file name is written on Msg Body (like images as cid). |
Google ReCaptcha
First, you need to submit for the ReCaptcha API (v2 + v3 comes together) in Google ReCaptcha Admin page.Don't forget to include the project primary Domain (in that case any sub domain will work) OR specific Sub-Domains list.
Setting the .INI Parameters
When running the app for the first time a settings window will appear.you can access this windows by running the app with "-setup" parameter.
| Field | Description |
|---|---|
| Hyper Username | The app user-name. make sure to register in hyper users if access manipulation is required. |
| Custom Hyper Database IP | Hyper DB IP, for direct access in case this app has no 5902 TCP access to SYE Supervisor Server. |
| Incoming Proxy IP:Port | The Local IP and TCP Port number for binding (listening). |
| Domain Address | The endpoint URL assigned to this app/purpose |
| Domain Purpose | Set the application role/purpose Default Web Portal - Hyper Default Registration $amp; Service Portal API mode (no HTML) - API Mode via secured connection Data Port (only) - Lead System Registration Database Connection (json) - Reserved Unsecured API mode - API Mode with no security for special cases only (CAREFUL!!!) |
| Max Posts per IP per Minute | Bypass for the defult internal protection system (10 posts per minut). |
| Http Media Path | Allow to manually set a local path for media files. Relevant for "Default Web Portal" only. If not set, the systems default path is the: AppDirectory/HTTP/Media/ |
| Block These Functions | When running in API mode only - Enter here the v4 function names to block (as stated in this api guide). |