Bundle Profile Reference Application

Table of Contents

• Overview
  • Compatibility
  • References
• Usage
  • Prerequisites
  • Configuration
  • Integrating with Open API Generator
  • Build and Execute
• Use Cases
• API Reference
  • Authorization
  • Request Examples
• Support

Overview

Bundle Profile is a product enrollment service that provides the ability for user enrollment into Mastercard solutions. Bundle Profile enables the following actions:

• Create a new enrollment into products
• View enrollment information
• Update the consumer and product enrollment information

This Reference application is a guide for using Bundle Profile APIs for Consumer Product Enrollment. Please visit Mastercard Developer portal for more details about the API: Mastercard Developers.

Compatibility

• Java 8 or later

References

• Mastercard’s OAuth Signer library
• Using OAuth 1.0a to Access Mastercard APIs

Usage

Prerequisites

• Mastercard Developers Account with access to "MastercardON" API
• A text editor or IDE
• Java 8
• Apache Maven 3.3+

Configuration

• Clone the project - git clone https://github.com/Mastercard/bundle-client-ref.git.

• Create an account at Mastercard Developers.

• Create new project and add MastercardON API to your project.

• Configure project and download signing key. It will download the zip file.

• Unzip the downloaded key and select .p12 file from zip and copy it to src/main/resources in the project folder.

• Open ${project.basedir}/src/main/resources/application.properties and configure below parameters.

  mastercard.bundle.client.api.base.path=https://sandbox.api.mastercard.com, its a static field, for making the API calls.

  mastercard.bundle.client.p12.path=BundleProfile.p12, this refers to the p12 file name obtained from aforementioned steps.

  mastercard.bundle.client.ref.app.consumer.key=Abcdfefgjhilklmnopqrstuvwxyz-dxcq_zD7IiPa0df175e!22a7fddba56e800000000000000000, this refers to your consumer key you get when you create a project under API.

  mastercard.bundle.client.ref.app.keystore.password=pwd, this refers to the password you obtain when you create the p12 key.

Integrating with OpenAPI Generator

You may refer to Open API Generatorused by "bundle-client-ref" that generates API client libraries from Open API Specs. It provides generators and library templates for supporting multiple languages and frameworks. (Note: This section is informational and developer who integrates need not perform these steps.)

See also:

• Open API Generator (maven Plugin)
• CONFIG OPTIONS for java

OpenAPI Generator Plugin Configuration

• maven plugin to build modules from Open API - Generator from the swagger given.

<!-- https://mvnrepository.com/artifact/org.openapitools/openapi-generator-maven-plugin -->
<plugin>
    <groupId>org.openapitools</groupId>
    <artifactId>openapi-generator-maven-plugin</artifactId>
    <version>${openapi-generator.version}</version>
    <executions>
        <execution>
            <goals>
                <goal>generate</goal>
            </goals>
            <configuration>
                <inputSpec>${project.basedir}/src/main/resources/bundle-profile.yaml</inputSpec>
                <generatorName>java</generatorName>
                <library>okhttp-gson</library>
                <generateApiTests>false</generateApiTests>
                <generateModelTests>false</generateModelTests>
                <configOptions>
                    <sourceFolder>src/gen/main/java</sourceFolder>
                    <dateLibrary>java8</dateLibrary>
                </configOptions>
            </configuration>
        </execution>
    </executions>
</plugin>

Build and Execute

Once you have added the correct properties, you are ready to build the application. You can do this by navigating to the project’s base directory from the terminal and then by running the following command.

mvn clean install

When the project builds successfully, you can run the following command to start the project.

java -jar target/bundle_client-1.0.0.jar <argument as below> Example : java -jar target/bundle_client-1.0.0.jar createUser

Argument: An argument which defines the feature user wants to run through the command line. If you don’t specify this argument, it will run all the features (create User, Read User, Update User (product / account)) one after the other. createUser, readUser, etc mentioned below are the arguments.

* createUser - User enrollment into products .
* readUser   - Retrieve user’s enrolled products .
* addProduct - Add products for a user.
* addAccount - Add a user account to the products .
* removeAccount - Remove user's account tagged on enrolled product.
* replaceAccount - Replace user's primary account number for all products tied to the existing primary account number.
* replaceUser - Update the user information across products.

Use Cases

Case 1: POST User Enrollment for user enrollment into products

• The Bundle Profile API allows you to enroll a user into products based on the product’s name passed in the request.

• For field level information, refer to model classes.

  URL	Method	Request	Response
  /users	POST	BundleUser	BundleUserResponse

Case 2: GET Products Enrolled for User to Retrieve user’s enrolled products

• The Bundle Profile API allows you to retrieve the product’s details for a specific User ID passed in the request.

  URL	Method	Request	Response
  /users/{userid}	GET	NA	BundleUserResponse

Case 3: PATCH Add User Account to add user account to the products.

• The Bundle Profile API allows to add user account to the products enrolled for a specific user passed in the API Endpoint. .

• For field level information, refer to model classes.

  URL	Method	Request	Response
  /users/{userid}/patches	POST	BundleUserPatch	BundleUserResponse

Case 4: PATCH Add Product to add products for a user.

• The Bundle Profile API allows to add Products for a specific user passed in the API Endpoint.

• For field level information, refer to model classes.

  URL	Method	Request	Response
  /users/{userid}/patches	POST	BundleUserPatch	BundleUserResponse

Case 5: PATCH Remove Account to remove user’s account tagged on an enrolled product.

• The Bundle Profile API allows to remove the account tagged on an enrolled product for a specific user passed in the API Endpoint.

• For field level information, refer to model classes.

  URL	Method	Request	Response
  /users/{userid}/patches	POST	BundleUserPatch	BundleUserResponse

Case 6: PATCH Replace Account to Replace User’s account number for all products tied to the existing payment card account number.

• The Bundle Profile API allows to replace user PAN Account with the given new PAN Account on an enrolled product for a specific user passed in the API Endpoint.

• For field level information, refer to model classes.

  URL	Method	Request	Response
  /users/{userid}/patches	POST	BundleUserPatch	BundleUserResponse

Case 7: PATCH Update User to update user information across products.

• The Bundle Profile API allows to update user personal information for a specific user passed in the API Endpoint.

• For field level information, refer to model classes.

  URL	Method	Request	Response
  /users/{userid}/patches	POST	BundleUserPatch	BundleUserResponse

Authorization

For configuring your API client, thecom.mastercard.developer.interceptors package provides you some request interceptor classes. These classes will take care of adding the correct Authorization header before sending the request.

Request Examples

You can change the default input passed to APIs, modify values in the src/main/resources/templates for POST and UPDATE Use case. {userid} field is editable in the RequestHelper.java class. Below are the static User ID values configured for the Bundle Profile Reference Application. You may pass the below User IDs for GET operation to retrieve information on user’s enrolled products.

• For Products (airport, Wi-Fi), User ID - user234 is supported
• For Products (rewards, benefits, offers), User ID - user1235 is supported
• For Product: specialpay (Note: This is a test product), User ID - specialpayUser is supported

Support

For any clarifications, please reach out to [email protected].