Template Customer Onboarding Process API

• License Agreement
• Use Case
• Considerations
  • APIs security considerations
• Run it!
  • Running on premise
  • Running on Studio
  • Running on Mule ESB stand alone
  • Running on CloudHub
  • Deploying your Anypoint Template on CloudHub
  • Creating externally reachable proxy and applying policies
  • Properties to be configured (With examples)

License Agreement

Note that using this template is subject to the conditions of this License Agreement. Please review the terms of the license before downloading and using this template. In short, you are allowed to use the template for free with Mule ESB Enterprise Edition, CloudHub, or as a trial in Anypoint Studio.

Use Case

As a new Retail API Led Connectivity Web Portal user I want a microservice to execute the signup process.

This template should serve as a foundation for implementing an API for Signing up a new Web Portal user. API is defined using RAML and this implementation uses APIkit. The Onboarding Process API retrieves credentials and patient data from the Portal Experience API and checks the Identity Service if the login is available. If it is available the API triggers creation of Patient from the underlying microservices defined in EHR to FHIR System API in JSON following the FHIR specification version 1.0.2 DSTU2 and new user with the specified credentials and Patient ID will be created in the Identity Service. If the login is not available user will be notified about that and able to choose the different login name.

The Onboarding Process API is part of the Retail Templates Solution and it is triggered by the Identity Service.

Considerations

To make this Anypoint Template run, there are certain preconditions that must be considered. Failling to do so could lead to unexpected behavior of the template.

APIs security considerations

This Process API is meant to be deployed within a CloudHub and managed using the API Platform Manager.

Exposing external endpoints with HTTPS

• It is triggered by the Identity Service using HTTPS

Exposing internal endpoints with RAML and HTTPS

• It is interconnected internally with Customer System API using HTTPS as well

Exposing internal endpoints with RAML and HTTP

• It is also interconnected with Notification System API

Run it!

Simple steps to get Onboarding Process API running. See below.

Running on premise

In this section we detail the way you should run your Anypoint Template on your computer.

Where to Download Mule Studio and Mule ESB

First thing to know if you are a newcomer to Mule is where to get the tools.

• You can download Mule Studio from this Location
• You can download Mule ESB from this Location

Importing an Anypoint Template into Studio

Mule Studio offers several ways to import a project into the workspace, for instance:

• Anypoint Studio generated Deployable Archive (.zip)
• Anypoint Studio Project from External Location
• Maven-based Mule Project from pom.xml
• Mule ESB Configuration XML from External Location

You can find a detailed description on how to do so in this Documentation Page.

Running on Studio

Once you have imported you Anypoint Template into Anypoint Studio you need to follow these steps to run it:

• Generate keystore (You can find a detailed description on how to do so in this Documentation Page)
• Locate the properties file mule.dev.properties, in src/main/resources
• Complete all the properties required as per the examples in the section Properties to be configured
• Once that is done, right click on you Anypoint Template project folder
• Hover you mouse over "Run as"
• Click on "Mule Application"

Running on Mule ESB stand alone

Complete all properties in one of the property files, for example in mule.prod.properties and run your app with the corresponding environment variable to use it. To follow the example, this will be mule.env=prod.

Running on CloudHub

While creating your application on CloudHub (Or you can do it later as a next step), you need to go to "Manage Application" > "Properties" to set all environment variables detailed in Properties to be configured. Follow other steps defined here and once your app is all set and started, there is no need to do anything else.

Deploying your Anypoint Template on CloudHub

Mule Studio provides you with really easy way to deploy your Template directly to CloudHub, for the specific steps to do so please check this link

Properties to be configured (With examples)

In order to use this Mule Anypoint Template you need to configure properties (APIs, configurations, etc.) either in properties file or in CloudHub as Environment Variables. The Onboarding Process API is using secured connection. Detail list with examples:

Application properties

• https.port 8082
• keystore.location keystore.jks
• keystore.password pass123!
• key.password pass123!
• key.alias 1

API auto-discovery

• api.id 16593582
• api.name customer-onboarding-process-api
• api.version v1
• anypoint.platform.client_id d345650985cc43fea4be72dac50aafe9
• anypoint.platform.client_secret 6628Fc1E3547f58418F0AFCe0B80FB11

###API calls configuration

• customer-system-api.baseUrl https://customer-system-api.cloudhub.io:443/api

• notifications-system-api.baseUrl http://dev-retail-notifications-system-api.cloudhub.io:80/api

• catalyst.url http:\\path-to-retail-portal.com