Creating GMO MakeShop-Connected Applications in Unqork

Overview

You can use CData Connect Cloud to feed GMO MakeShop data to Unqork. From there you can build custom business applications in a visual, drag-and-drop interface. So, how does this process work?

Unqork is a completely visual, no-code application development platform that helps large organizations build complex custom software. CData Connect Cloud exposes GMO MakeShop as a REST endpoint, which you can then query from Unqork with simple HTTP requests. This enables you to create your own custom application with GMO MakeShop data.

What You'll Learn

In this article, you'll learn how to:

• Add a CData Connect Cloud user
• Add a Personal Access Token for the Connect Cloud user
• Connect to GMO MakeShop from Connect Cloud
• Add GMO MakeShop OData endpoints in Connect Cloud
• Register GMO MakeShop (via Connect Cloud) as on Unqork service
• Create a simple Unqork application to display GMO MakeShop data

Connect to GMO MakeShop from Unqork

To work with live GMO MakeShop data in Unqork, you need to:

• Connect to GMO MakeShop from CData Connect Cloud
• Provide user access to the new connection in CData Connect Cloud
• Create OData endpoints for GMO MakeShop data

(Optional) Add a New Connect Cloud User

As needed, create Users to connect to GMO MakeShop through Connect Cloud.

1. Navigate to the Users page and click Invite Users
2. Enter the new user's email address and click Send to invite the user
3. You can review and edit users from the Users page

Add a Personal Access Token

If you are connecting from a service, application, platform, or framework that does not support OAuth authentication, you can create a Personal Access Token (PAT) to use for authentication. Best practices would dictate that you create a separate PAT for each service, to maintain granularity of access.

1. Click on your username at the top right of the Connect Cloud app and click User Profile.
2. On the User Profile page, scroll down to the Personal Access Tokens section and click Create PAT.
3. Give your PAT a name and click Create.
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

Connect to GMO MakeShop from Connect Cloud

CData Connect Cloud uses a straightforward, point-and-click interface to connect to data sources.

1. Log into Connect Cloud, click Connections and click Add Connection
2. Select "GMO MakeShop" from the Add Connection panel
3. Enter the necessary authentication properties to connect to GMO MakeShop.

   Configuring Access to GMO MakeShop

   GMO MakeShop requires AccessCode for each API. To obtain MembersAccessCode, OrdersAccessCode, ProductsAccessCode, and ShopId, follow the steps below:

   • Log in to the GMO MakeShop Store Manager and click Create Shop.
   • Click any target connection setting from External System Connection in the left-hand navigation menu. If you cannot find it in the menu, please contact GMO Makeshop.
   • Product Data Connection Settings: Click Issue to retrieve the authentication code and ProductsAccessCode.
   • Order Data Connection Settings: First select Get Order Information > Change Order Information settings. Then click Issue to retrieve the authentication code and OrdersAccessCode.
   • Members Data Connection Settings: Select Get/Post/Update/Delete Members Information settings. Then click Issue to retrieve the authentication code and MembersAccessCode.
   < li>Members Authentication Connection Settings: Click Issue to retrieve the authentication code and ProductsAccessCode.

   Authenticating to GMO MakeShop Account

   Set the following connection properties to connect:

   • ShopId: Set the GMO MakeShop Store ID of the connection destination. The GMO MakeShop Store ID is the same as the ID for login.
   • OrdersAccessCode: Set the orders access code retrieved from Order Data Connection Settings. This property is required to access the Orders table.
   • ProductsAccessCode: Set the products access code retrieved from Product Data Connection Settings. This property is required to access the Products table.
   • MembersAccessCode: Set the members access code retrieved from Members Data Connection Settings. This property is required to access the Members table.
   • MemberAuthenticationCode: Set the member authentication code retrieved from Members Authentication Connection Settings. This property is required to execute MemberAuthenticationConfirm.
   • Password: Specify the password for the GMO MakeShop Store Manager login user. This property is required to execute ProductCategoryRegistrationOrModification, ProductMemberGroupPriceRegistrationOrModification, ProductOptionRegistrationOrModification, and ProductRegistrationOrModification.
   
4. Click Create & Test
5. Navigate to the Permissions tab in the Add GMO MakeShop Connection page and update the User-based permissions.

Configure GMO MakeShop Endpoints for Unqork

After connecting to GMO MakeShop, create a workspace and virtual dataset for your desired table(s).

1. Navigate to the Virtual Datasets page and click Add to create a new Workspace (or select an existing workspace).
2. Click Add to add new assets to the Workspace.
3. Select the GMO MakeShop connection (e.g. GMOMakeShop1) and click Next.
4. Select the table(s) you wish to work with and click Confirm.
5. Make note of the OData Service URL for your workspace, e.g. https://cloud.cdata.com/api/odata/{workspace_name}

Sample URLs for Workspaces

Once you have configured a connection to GMO MakeShop, created a user, and created Workspace(s) in Connect Cloud, you can access OData feeds for GMO MakeShop data. Below, you will see the URLs to access tables and the list of tables. For information on accessing the tables, you can navigate to the OData page for Connect Cloud. For the URLs, you will need the URL of Connect Cloud: https://cloud.cdata.com/api/odata/{workspace_name}.

As with standard OData feeds, if you wish to limit the fields returned, you can add a $select parameter to the query, along with other standard OData URL parameters, such as $filter, $orderby, $skip, and $top. See the help documentation for more information on supported OData queries.

With the connection and OData endpoints configured, you are ready to connect to GMO MakeShop data from Unqork.

Create a Simple Application for GMO MakeShop Data

With the REST API configured for GMO MakeShop through Connect Cloud, you are ready to create a GMO MakeShop-connected application in Unqork. Here are the basic steps to this process:

• Register GMO MakeShop (via Connect Cloud) as an Unqork service
• Create a workspace in Unqork
• Create a module-type application

Register GMO MakeShop (via Connect Cloud) as an Unqork Service

To connect to Connect Cloud, you need to give your environment permission to connect with an external service. Do this through Services Administration.

1. Click the Settings drop-down at the top right corner of the Unqork Designer Platform.
2. Click Administration.
3. Under Integrations, click Services Administration.
4. Enter a Service Title, for example, Connect Cloud.
5. Enter a Service Name, for example, cdataConnect.
6. Enter a Service protocol + host. This is the API endpoint you want to reference. For example, https://cloud.cdata.com/api/odata/{workspace_name}.
7. Select Basic Auth from the Type of Authentications drop-down.
8. Enter the Connect Cloud user ID (e.g. [email protected]) in the User Name field.
9. Enter the Connect Cloud user PAT in the Password field.
10. Click Add Service.

Create a Workspace

Unqork lets you create your own workspace, which is a virtual container for you and your team to store and organize your applications. Once you build a workspace, you can add applications to it.

To create a workspace:

1. Click Create Workspace
2. Enter a unique Workspace Name
3. Click Create

Your workspace tile appears under the Workspaces tab.

Create a Module-Type Application

With your workspace added, you are ready to create your application. You have the choice between a module-type and workflow-type application. For this use case, make a module-type application.

1. Navigate to the Apps tab from your open workspace.
2. Click Create App.
3. Enter a unique App Name.
4. Select a preview style from the Style drop-down. A style specifies your application's appearance to your and-users. If left blank, your application uses the environment's default style.
5. Select Module from the App Type drop-down.
6. Select New Entrypoint Module from the App Entrypoint Module drop-down.
7. Click Create.

You will land on the Modules tab of your new application. It should look like the following:

Click the title to name the module in the Module Editor.

To complete your application, you need the following components:

• Hidden component: stores the data retrieved by the Plug-In
• Initializer component: executes the Plug-In when displaying tables
• Plug-In component: retrieves GMO MakeShop data through Connect Cloud and stores it in the Hidden component
• ViewGrid component: creates on HTML table from the data stored in the Hidden component

Configure the Hidden Component

This Hidden component stores the GMO MakeShop data retrieved through Connect Cloud.

1. Drag and drop a Hidden component onto your canvas.
2. Enter a Property ID and Canvas Label Text.

   NOTE: Property IDs must be in Camel Case (stylized as camelCase). For example, hiddenComponent. Since the Hidden component is not visible to and-users, use your Property ID as the Canvas Label Text.

3. Click Save.

Configure the Plug-in Component

Next, add a Plug-In component to request data from Connect Cloud. This component connects with the service you set up in Services Administration.

1. Drag and drop a Plug-In component onto your canvas, placing it below the Hidden component.
2. Enter a Property ID and Canvas Label Text.

   NOTE: You must use Camel Case (stylized as camelCase). For naming best practices, start your Plug-In's Property ID with plugin. For example, pluginGetAWProducts.

3. Configure the Outputs table as follows:
   • Enter the Property ID of your Hidden component in the Property ID column.
   • Enter value in the Mapping column.
4. Select External as the Service Type
5. From the External Services drop-down, select your Connect Cloud service. This is the external service you set up in Services Administration.
6. Add the specific endpoint for your Connect Cloud resources to the and of the Data Sources URL. For example, AdventureWorks2012_Production_Product.

   NOTE: Your Data Sources URL will have a value similar to: https://cloud.cdata.com/api/odata/{workspace_name}/AdventureWorks2012_Production_Product.

7. Click Save.

Configure the Initializer Component

The Initializer component is what fires the Plug-In to retrieve your GMO MakeShop data.

1. Drag and drop on Initializer component onto your canvas, placing it above the Plug-In component.
2. Enter a Property ID and Canvas Label Text.

   NOTE: You must use Camel Case (stylized as camelCase). For naming best practices, start your Initializer's Property Name with init. For example, initGetAWProducts.

3. Set New Submission as the Trigger Type.
4. In the Outputs table, enter the following:
   • Enter the Property ID of your Plug-In in the Property ID column's field.
   • Enter trigger in the Type column's field.
   • Enter GO in the Value column's field.
5. Click Save.

Configure the ViewGrid Component

The ViewGrid component references the data stored in your Hidden component. Then, it displays the GMO MakeShop data to your and-users in a dashboard (or table).

1. Drag and drop a ViewGrid component onto your canvas, placing it below the Plug-In component.
2. Enter a Label and Property Name.

   NOTE: You must use Camel Case (stylized as camelCase). For naming best practices, start your ViewGrid's Property Name with vg. For example, vgAWProductView.

3. In the Inputs table, set id to the Property ID of the hidden component.
4. In the Display table:
   • In the id column: enter the IDs of the fields you want to display.
   • In the handing column: enter the title you want for each field. This is how the field will display to your and-users.
   
5. Click Save.
6. Save your module.

Once you add and configure the above components, you can preview how your application looks to and-users. In the Module Editor, click Preview Module to see the front-facing view (or "Express View") of the module.

Your Express View module should look something like this:

More Information & Free Trial

With Connect Cloud and Unqork, you can easily build GMO MakeShop-connected applications. Request a free trial of Connect Cloud and start working with GMO MakeShop data in Unqork today.