Hyper Web API - Version 5.x

This is the latest version of the Web API, designed to connect mobile applications, websites, and third-party software to the Hyper CRM/ERP system.
Throughout the manual, you will find examples of JSON request and response objects. In this page we demonstrate the whole HTTP protocol.
An index of all error codes and messages is provided on the next page.

Let's examine HTTP by calling the Get_Countries_List_Json function, It retrieves a comprehensive countries list.


GET /Get_Countries_List_Json HTTP/1.1
Accept: */*
Accept-Language: en
Cache-Control: no-cache
Connection: Close
Host: dev.sye.co.il
User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) Chrome/120.0.0.0
Authorization: Bearer Bvs2....................vJw

===== HTTP Response =====
HTTP/1.1 200 OK
Connection: close
Accept-Ranges: bytes
Content-Type: application/json; charset=utf-8
Content-Length: 18518
Cache-Control: no-store, no-cache, must-revalidate
Date: Tue, 01 Apr 2025 08:00:00 GMT
X-Frame-Options: SAMEORIGIN
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Access-Control-Allow-Origin: *

{
  "ResponseCode":0,
  "Countries":[
    {
      "Name":"Afghanistan",
      "Hebrew":"אפגניסטן",
      "Terror":"1",
      "Block":"1"
    },
    {
      "Name":"Albania",
      "Hebrew":"אלבניה",
      "Terror":"0",
      "Block":"0"
    }
  ]
}

Now let's try the Get_Banks_List_json function, It retrieves a Banks index for a specific country.


GET /Get_Banks_List_json?country=USA HTTP/1.1
Accept: */*
Accept-Language: en
Cache-Control: no-cache
Connection: Close
Host: dev.sye.co.il
User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) Chrome/120.0.0.0
Authorization: Bearer Bvs2....................vJw

===== HTTP Response =====
HTTP/1.1 200 OK
Connection: close
Accept-Ranges: bytes
Content-Type: application/json; charset=utf-8
Content-Length: 56
Cache-Control: no-store, no-cache, must-revalidate
Date: Tue, 01 Apr 2025 08:00:00 GMT
X-Frame-Options: SAMEORIGIN
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Access-Control-Allow-Origin: *

{
  "ResponseCode":2,
  "ResponseMsgEng":"No Results \/ Data"
}

Conclusion

Regarding authentication, the API requires a valid Access Token provided from the Hyper client app.
Detailed information regarding the connection methodology and tokens can be found here.
Error responses consistently use the same format (ResponseCode and ResponseMsgEng).
Successful executions return structures that vary depending on the specific function context.
Codes 0, 1, and 2 represent different states of a successful request.
When uploading files, always use a
multipart/form-data
POST request (including the boundary string), adhering to standard browser behavior.

Forms UI - Get Value Lists from Hyper

This section describes the Server-to-Server synchronization functions.
Ajax Auto-Completion functions are not covered here, as they are part of the HTML web application interface.

Get_Banks_List_Json

This function returns a Banks index for a specific country from the

SYE_Countries Banks List

table.

Input Field	Description
Country	Full country name. Refer to the internal table named: SYE_Countries Banks List. If you omit this field or post it empty, the default value is 'Israel'.

//===// Request
{
  "Country":"israel"
}
//===// Response
{
  "ResponseCode":0,
  "Banks":[
    {
      "code":"4",
      "name":"בנק יהב לעובדי המדינה בע\"מ",
      "Branches":[
        {
          "Code":"7",
          "Name":"מלחה ירושלים",
          "Address":"אגודת הספורט בית\"ר 1 קניון עזריאלי מלחה ירושלים ירושלים 9543501 | 02-5009911",
          "Open_Date":"09\/01\/2011",
          "Close_Date":""
        },
        {
          "Code":"44",
          "Name":"הלל יפה חדרה",
          "Address":"דרך השלום 1 בית החולים הלל יפה חדרה 9757023 | 02-5009911",
          "Open_Date":"25\/09\/2011",
          "Close_Date":""
        },
        {
          "Code":"110",
          "Name":"מרכז תפעול עורפי*-מרחב צפון",
          "Address":"ירמיהו 80 ירושלים 9446759 | 02-5009911",
          "Open_Date":"04\/01\/2021",
          "Close_Date":""
        }
      ]
    }
  ]
}
// In the event of an empty list, the "ResponseCode" will be 2, and the message format corresponds to the standard error structure:
{
  "ResponseCode":2,
  "ResponseMsgEng":"No Results \/ Data"
}

Get_Countries_List_Json

This function retrieves a comprehensive countries list from the

SYE_Countries Table

, cross-referenced with the

SYE_Countries Black List

.
Function input: No payload is required.

//===// Response
{
  "ResponseCode":0,
  "Countries":[
    {
      "Name":"Afghanistan",
      "Hebrew":"אפגניסטן",
      "Terror":"1",
      "Block":"1"
    },
    {
      "Name":"Albania",
      "Hebrew":"אלבניה",
      "Terror":"0",
      "Block":"0"
    },
    {
      "Name":"Canada",
      "Hebrew":"קנדה",
      "Terror":"0",
      "Block":"0"
    }
  ]
}