Installation Guide

Welcome to the installation guide for our headless promotion engine API. In this guide, we will walk you through the steps required to install and set up the API on your platform.

Prerequisites:

1. Basic knowledge of API development and deployment.
2. An API development environment, such as Node.js copy or Python.
3. Access to the internet.

Step 1: Get API Credentials

To start using the API, you need to get API credentials. Contact our team to obtain API credentials.

Step 2: Download the API Package

Once you have obtained the API credentials, download the API package from the download link provided to you by our team. OR Click Here

Step 3: Install Dependencies

The API package requires some dependencies to be installed before running it. Install the required dependencies by running the following command:

> npm install

Step 4: Configure Environment Variables

The API package requires environment variables to be set up. Copy the sample .env.example file to a new file named .env and update the API credentials and other configuration variables in it.

Step 5: Run the API Server

Start the API server by running the following command:

> npm start

This will start the API server on the default port of 3000. You can access the API endpoints by sending HTTP requests to this URL: http://localhost:3000/ (opens in a new tab).

Congratulations! You have successfully installed and set up the API on your platform. You can now start using the API to create, delete, update and list static and dynamic coupons.

If you face any issues during the installation process, please contact our support team for assistance.