Show TOC

REST API Application Development Locate this document in the navigation structure

The REST Services, distributed as part of the SAP Mobile Platform (on-premise) and SAP HANA Cloud Platform mobile services (Cloud), enables standard HTTP client applications running in any platform to leverage mobile platform for security and push features.

Note The term mobile platform used in this documentation is applicable to both on-premise and cloud versions.
Build client applications using third-party developer tools (JavaScript framework and helper libraries), native client libraries, or the libraries provided by SAP Mobile Platform OData SDK (iOS and Android platforms only). SAP Mobile Platform enables you to manage and monitor the applications, and provides support for native push notification: Apple Push Notification service (APNS), BlackBerry Internet/Enterprise Service (BIS/BES), Google Cloud Messaging (GCM), Windows Notification Service (WNS), or Microsoft Push Notification Service (MPNS).
Develop client applications to first register an application connection with device information, such as device type, password capability, and so on. Once registered, an application can retrieve and update the application connection settings through the REST API. You can enable or disable the push notification only after registering.
Note You can delete an application connection using the REST API, as long as the application is not in use. Any data that is stored in the custom string of the application connection properties is lost.

During initialization, a client application can download resources (such as metadata files, multimedia files, and so on.), using the resource bundles service.

After downloading resources, the application can access OData-compatible data sources through the proxy service, and receive native push notifications triggered by the gateway if push properties are configured and enabled.

The client usage data upload (also known as usage reporting) mechanism is used to gather client usage data and persist it to the database, so that it can be consumed by the Management Cockpit, Mobile Services Cockpit, or by SAP and third-party tools.

This development approach supports:
  • Registration (creating an application connection)
  • Authentication
  • Native push notification
  • Usage reporting

For more information on supported REST API application development environment versions for on-premise mobile platform, see the SAP Product Availability Matrix (PAM) at published on SAP site.

Cloud solutions do not have a PAM. For more information about cloud solution product versions contact SAP representative.

For more information on developing applications using REST APIs, see REST API App Development under: