Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The SH5 Web API 2 server or simply the Web API is used to integrate SH5 and other applications. For more details about working with the SH5 API see here. 

Web API installation

SH5 Web API II, or simply Web API, can be downloaded from the FTP server at: ftp://ftp.ucs.ru/StoreHouse%205/API_V2/

Download the archive with the installer and unzip it to the suitable folder.
 Image Added

Run the installer and install the server according to the screenshots below.:

  1. Read and accept the terms of the
User
  1. license agreement
    Image Added

2. Select the language and desired a required action: installing or updating upgrading the Web API
Image Added

3. Specify the port Web AP server will run on. Enter the address and port of the running SH5 server
Image Added

4.

Click Install.
Image Added

The program will be installed at C:\Program Files (x86)\UCS\SH5_WebApi_I\
After installation, a testing utility designed to test the connection between the Web API and SH5 will be opened.

By clicking the clicking GET, Info and other buttons, the utility makes a request via the API to SH5 and outputs the result. We recommend trying various requests to make sure that the servers work correctly.
Results of a valid GET response:
Image Added

If the settings are incorrect or the Web API does not work, you will see the message the Connection refusedmessage:

 Translating report layouts          Working with the Web API directly Image Added