Set Up the API Server

Deploy

The API Server runs on your own server. On Windows, you can deploy using the stand-alone server or IIS. On a Java servlet container, drop in the API Server WAR file. See the help documentation for more information and how-tos.

Connect to GMO MakeShop

After you deploy the API Server and the ADO.NET Provider for GMO MakeShop, provide authentication values and other connection properties needed to connect to GMO MakeShop by clicking Settings -> Connections and adding a new connection in the API Server administration console.

You can then choose the GMO MakeShop entities you want to allow the API Server access to by clicking Settings -> Resources. This article uses Products as an example.

Authorize API Server Users

After determining the OData services you want to produce, authorize users by clicking Settings -> Users. The API Server uses authtoken-based authentication and supports the major authentication schemes. You can authenticate as well as encrypt connections with SSL. Access can also be restricted by IP address; Access is restricted to only the local machine by default.

Create the View

In this article the user views and interacts with GMO MakeShop data through an SAPUI5 table control. Table columns will be automatically detected from the metadata retrieved from the API Server's API endpoint. We define the following table in a separate View.view.xml file:

Create the Model and Controller

In SAPUI5, you do not need to write any OData queries; an ODataModel instance handles the application's data access commands.
The API Server then translates the queries into GMO MakeShop API calls.

The controller processes user input and represents information to the user through a view. Define the controller in a new file, Controller.controller.js. Instantiate the model in the onInit function -- you will need to replace the placeholder values for the URL to the API Server, a user allowed to access the OData endpoint of the API Server, and the authtoken for the user.