Configure API

Before You Start

CampaignsPlus offers a complete API library to help you perform list of functions programmatically using API requests. These APIs would help you programmatically access, inserts, add, update and delete many of the functions within CampaignsPlus. Before we move to discuss the available APIs, some important information is discussed in the following area.

API Token 

You need to have a valid API token for a successful API call. Invalid or expired API token will end up on an error.  

Navigate to Generate an API Token

Upon landing on the intended page, just click API token a button underneath a field to show the API token. Once clicked, system will generate a token for your account that you can copy and later can use while sending an API request.  

API End Point

One more thing is required for every API request and that is API End Point. The end point refers to the unique URL that exposes the data you are programmatically interacting with. For every API request, end points will have little variations, apart from the installation domain name which will remain same. CampaignsPlus is a SaaS app hosted on a cloud instance, but you mostly have the ability to select the subdomain for the installation URL. What it means, the URL your instance is installed on would appear like, http://my.mumara.host. This much part of the End Point URL will remain the same for the all API requests but the later part after / however would change, that we’ll discuss for every API.

Method

From method refers to the API call between the two “Get” or “Post”.