RAD Server Client Application

Go Up to RAD Server (EMS)

A RAD Server Client application is a REST application that uses the services from the RAD Server Engine (EMS Server).

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

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

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

Connecting to an RAD Server Engine from Your RAD Server Client Application

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

• URLHost. The URL of the RAD Server Engine. Use:
  • localhost if the RAD Server Engine is running on the same machine.
  • IP Address of the remote RAD Server Engine if it is running on a different machine.
• URLPort. The connection port of the RAD Server Engine.
  • Default value: 8080
• URLProtocol. The URL protocol identifier for the request to the RAD Server Engine.
  • 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 RAD Server Engine Authorization settings needed to connect to the RAD Server Engine (EMS Server).

Accessing a RAD Server Resource Endpoint from Your RAD Server Client Application

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

Method	Use
TBackendUsers	Retrieve, update or delete RAD Server Users.
TBackendQuery	Query on RAD Server Users and RAD Server Groups.
TBackendAuth	Login, Logout, Signup, and set authentication for other TBackend components.
TBackendEndpoint	Invoke a particular or custom RAD Server Endpoint Resource.
TBackendGroups	Add, get, update, and delete RAD Server Groups.
TEMSFireDACClient	Invoke a RAD Server 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 RAD Server Resource Endpoint that you want to access:

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

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

Method	Use	Description
rmGET	To retrieve data from the RAD Server Resource	The endpoint is called using HTTP GET.
rmPUT	To insert data in an RAD Server Resource	The endpoint is called using HTTP PUT.
rmPOST	To update a complete RAD Server Resource	The endpoint is called using HTTP POST.
rmPATCH	To update partial RAD Server Resources	The endpoint is called using HTTP PATCH.
rmDELETE	To delete an RAD Server Resource	The endpoint is called using HTTP DELETE.

See Also

• RAD Server Engine (EMS Server)
• RAD Server Engine Authorization
• Extending the RAD Server Engine
• Multi-Device Application
• Tutorial: Implementing Your First RAD Server Client Application
• Tutorial: Implementing a FireDAC RAD Server Client Application
• Tutorial: RAD Server Client Application to Manage RAD Server Users