WordPress MicroPayments (CMMP) + External API Add-on - Use Case - Control Wallet From External Apps

Use Case - How to Control Wallet From External Apps

Back to User Guides

Introduction

The WordPress MicroPayments is a points and rewards plugin for WordPress that allows you to create digital wallets for your users, reward them with points, and let them pay for them using real money.

The MicroPayments External API Add-on, in turn, gives you the power to connect the plugin to other apps. As a result you can, for example, create an Android app with a button that adds points to a MicroPayments wallet.

Back-end Example

Use Case Assumptions

In this example use case guide, we'll cover how to set up wallets for you users and allow them to buy points with real money.

We consider that you have already bought the plugin, but not installed it. 

It follows:

• Installing the plugin
• Setting up WordPress MicroPayments recap
• What you can do with this add-on
• Set Up
• How To Use This Add-on - Actions
  1. Check if Wallet has Enough Points
  2. Withdraw points
  3. Charge/Top up Wallet
• External wallet
• Response Format

Installing the Plugin and Add-on

The process is the same for all CM plugins.

• Download the add-on from your customer dashboard.
• Log in to WordPress and navigate to the WordPress Admin  → Plugins settings.
• Click on Add New.
• Activate it and add the license.

Setting Up WordPress MicroPayments - Recap

If you still have question with these steps:

• Installing the plugin
• Setting up WordPress MicroPayments
• How users can obtain points
• Grant points for purchase
• Use points for discounts
• Translating the interface
• Shortcodes
• Reports
• Exporting wallets to CSV
• Adding or subtracting points periodically 
• Troubleshooting

Then check the guide WordPress MicroPayments (CMMP) - Use Case - How to Allow Users to Buy Points Using Real Money.

What You Can Do With This Add-on

The MicroPayments External API Add-on allows you to connect your apps to wallets. This works by using WordPress REST API methods.

Allowed HTTPs requests

• GET
• POST

Supported actions

• Check if wallet has enough points
• Withdraw points
• Charge wallet

You can also allow external calls to the site to perform those actions.

Installation

Installing an add-on works just as installing a plugin. The only requirement is that the base plugin (WordPress MicroPayments) has to be activated in order for the add-on to work.

Check the article for the base plugin: WordPress MicroPayments Plugin (CMMP) - Installation

Set Up

To start using the add-on, head to Admin Dashboard → CM Micropayment Platform → Settings → External API tab.

• Enable the Open external API gateway option to allow external requests, effectively enabling this add-on.
• Click the Generate secure key button. You will use this key as an argument. Clicking on it again will generate a new one.

How To Use This Add-on

This is the list of actions with their respective URLs and arguments.

Actions

External Wallets

Starting from version 1.0.2, it's possible to add calls from external site to manage wallets. This requires configuration in both server and client sides.

Setup 1) Server Side

1. Setup the External API credentials. Head to Settings → External API tab. Here, check Open external API gateway and generate an API key.

   

2. Generate the wallets.

Setup 2) Client Side

1. Head to Settings → External wallet tab.

   

2. Past the API secure key that was just generated.
3. Check the option Enable external wallet.

4. Add the URL of the main site including the http protocol to the field API host URL. (Example: https://www.site.com)

   

This completes the configuration!

Checking Connection

You can check the connection at any time by pressing the relevant button:

When You Add Points

Every time you add points from the main site, you should refresh the state by pressing the relevant button:

Response Format

The response format is JSON.

• "success" - true or false.
• "message" - explain what is wrong if "success" is false.

Example 

• {"success":false,"message":["Wallet doesn't have enough points"]}{"success":true,"message":[]}
• {"success":false,"message":["Please provide wallet id or email and points"]}
• {"success":false,"message":["Please provide a secure key"]}

	More information about the WordPress MicroPayments plugin Other WordPress products can be found at CreativeMinds WordPress Store
	Let us know how we can Improve this Product Documentation Page To open a Support Ticket visit our support center