Mono Partner's API (WhiteLabel)

Welcome to the Quickstart Guide for Mono Partners API. This guide will walk you through the steps to quickly set up Mono’s Partners API for connect so that you can start using our white-labelled APIs and integrate with this service.

1. Introduction

Mono P.A. app is a simple app used to connect a bank account using the Partners API for connect. In this guide, we'll show you how to set up Mono’s partners API quickly and easily.

2. Prerequisites

Before you begin, make sure you have the following prerequisites in place:

• Node.js and npm installed
• Sign up on the Mono Dashboard ➡
• Create an App and fetch the generated Secret Key ➡

3. Setting Up Without Docker

Follow these steps to set up Mono Partners API without using Docker:

1. Clone and set up Mono P.A:

   Download the Mono P.A. web application files from our GitHub repository. Navigate to the project directory using the command line.

   Bash

   git clone <https://github.com/kingkenway/quickstart-mono-pi.git>
   cd quickstart-mono-pi
   
   

2. Install Dependencies:

   Install the necessary dependencies for both the Vue and Express apps.

   Bash

   # In the Vue app directory
   cd vue
   npm install
   
   # In the Express app directory
   npm install
   
   

3. Configure API Key and Secret Key:

   Create a file named .env in the root of the Mono P.A directory and add your API key and secret key.

   SECRET_KEY=your-secret-key
   PORT=3000
   
   

   Replace your secret key with your actual secret key.

4. Run Mono P.A:

   Start both the Vue and Express apps concurrently.

   Bash

   npm start
   
   

   This will launch the application, and you can access it by opening your browser and navigating to http://localhost:3000.

4. Setting Up With Docker

If you prefer to use Docker for your setup, follow these steps

Step 1: Clone the Mono P.A repository from GitHub, which includes the Dockerfile:

git clone <https://github.com/kingkenway/quickstart-mono-pi.git>

Step 2: Build the Docker image:

cd quickstart-mono-pi
docker build -t quickstart-mono-pi .

Step 3: Run a Docker container with the necessary environment variables set:

docker run -e SECRET_KEY=your-secret-key -e VUE_APP_API_URL=http://127.0.0.1:8000 -p 3000:3000 quickstart-mono-pi

Replace your-secret-key with your actual API secret key.

5. Configuration

In this section, you'll configure Mono P.A using environment variables stored in a .env file. Create a file named .env in the root of the Mono P.A directory and add the following:

SECRET_KEY=your-secret-key
PORT=3000

Replace your-secret-key with your actual API secret key.

6. Testing Your Setup

Before you start integrating Mono P.A. into your project, let's run the provided simple web app built with Express, and Vue.js to ensure everything is set up correctly.

Prerequisites

Ensure you have Node.js and npm installed on your machine.

Steps

1. Open a terminal and navigate to the Mono P.A directory.

2. Install the necessary dependencies for both the Vue and Express apps.

   Bash

   # In the Vue app directory
   cd vue
   npm install
   
   # In the Express app directory
   npm install
   
   

3. Start both the Vue and Express apps concurrently:

   Bash

   npm start
   
   

4. Open your browser and visit http://localhost:3000. You should see the Mono P.A web app in action.

7. Next Steps

Congratulations! You've successfully set up Mono P.A. Now, you're ready to start building amazing applications with our API. Here are some suggested next steps:

• Link to API Reference
• Information on how to integrate Mono P.A. into your project can be found here.
• Support and community resources can be found here.

GitHub link to clone: https://github.com/kingkenway/quickstart-mono-pi.git

Deployed link to test: https://partnersapi-quickstart.onrender.com/

The provided web app is a simple demonstration of Mono P.A. integration. It displays a basic webpage at http://localhost:3000, and you can explore further by interacting with the Mono P.A. functionalities embedded in the app.

Feel free to inspect the code in the provided files to understand how Mono P.A is integrated into an Express and Vue web app.

Remember to replace placeholders with your actual secret key and other relevant information in the configuration steps. If you encounter any issues or have questions, don't hesitate to reach out to our integration team at [email protected].

Happy coding!