Show: Delphi C++
Display Preferences

EMS Client Application

From RAD Studio
Jump to: navigation, search

Go Up to Enterprise Mobility Services (EMS)


An EMS Client application is a REST application that uses the services from the EMS Server.

The EMS Client application makes REST API calls to the EMS server to retrieve, create or update data. To access the EMS Server Resources and information from the EMS database, your EMS Client application can use the administrative built-in API or a custom API.

To start using the EMS server services from your EMS Client application, create a Desktop Application or a Multi-Device Application and use the TEMSProvider component to set up the connection to the EMS Server.

You can also use existing FireDAC components with your EMS Client application. See Tutorial: Implementing a FireDAC EMS Client Application.

Connecting to an EMS Server from Your EMS Client Application

Use the TEMSProvider component to set up the connection to the EMS Server. Modify the following properties to set up the connection properly.

  • URLHost. The URL of the EMS Server. Use:
    • localhost if the EMS Server is running on the same machine.
    • IP Address of the remote EMS Server if it is running on a different machine.
  • URLPort. The connection port of the EMS Server.
    • Default value: 8080
  • URLProtocol. The URL protocol identifier for the request to the EMS Server.
    • Default value: http
  • URLBasePath. (For a production environment) Virtual directory of the emsserver.dll and the emsserver.dll file name.
    • Default value (production environment): /emsserver/emsserver.dll

Configure the EMS Server Authorization settings needed to connect to the EMS Server.

Accessing an EMS Resource Endpoint from Your EMS Client Application

You can use the following components in your EMS Client application to access the endpoints of your EMS Server.

Method Use

TBackendUsers

Retrieve, update or delete EMS Users.

TBackendQuery

Query on EMS Users and EMS Groups.

TBackendAuth

Login, Logout, Signup, and set authentication for other TBackend components.

TBackendEndpoint

Invoke a particular or custom EMS Endpoint Resource.

TBackendGroups

Add, get, update, and delete EMS Groups.

TEMSFireDACClient

Invoke an EMS custom resource, and get or update tables using FireDAC.

Note: TBackendUsers, TBackendQuery, and TBackendAuth components also work with Parse and Kinvey (as BaaS providers).


Using TBackendEndpoint Component

If you use the TBackendEndpoint component, you need the following information from the EMS Resource Endpoint that you want to access:

  • Resource. The name of the EMS Resource.
  • Resource suffix. The suffix detailed in the resource endpoint method (if needed).
  • Method. The type of EMS Resource Endpoint method that is called.

The EMS Endpoint methods are defined in the EMS Resources. The following table shows you the available options:

Method Use Description

rmGET

To retrieve data from the EMS Resource

The endpoint is called using HTTP GET.

rmPUT

To insert data in an EMS Resource

The endpoint is called using HTTP PUT.

rmPOST

To update a complete EMS Resource

The endpoint is called using HTTP POST.

rmPATCH

To update partial EMS Resources

The endpoint is called using HTTP PATCH.

rmDELETE

To delete an EMS Resource

The endpoint is called using HTTP DELETE.

See Also

Personal tools
In other languages
Previous Versions
Assistance