Server API

Request exchange with mobile platform server is executed via HTTP API.

Before getting started with server API methods see the sections: Formats for Sending Data to Input, Special Headers, Designating Delta Versions in Requests.

To check mobile platform server availability:

• Execute requests using the "status" API method:

• Specify address in browser address bar:

http://<IP address or DNS name of prepared server>/api/v1/status/

After executing one of the operations a JSON string is obtained with the result of mobile platform server availability check.

The successful result of mobile platform server availability check:

{"message":"Welcome to Foresight Mobile Platform.","time":"2019-03-19T12:35:53.390324"}

NOTE. The mobile platform server can be checked without authentication.

API of the server, with which a developer can interact:

• Method for getting the current server version and supported API versions.

• API user authentication method.

• Method for getting resource description.

• Method for working with table resources.

• Method for working with transactions.

• Method for working with file server resources.

• Method for working with cache.

• Method for working with logs.

• Method for working with push notifications.

• Method for working with JSON.

• Method for working with MS Exchange.

• Method for working with WEB resource.

• Method of working with CryptoPro DSS.

• Method of checking password correspondence with specified requirements.

• Method of user password change.

NOTE. The current mobile platform version supports API versions v0.6 and v0.7.

See also:

Development