Configure API

Before You Start

CampaignsPlus offers a complete API library to help you perform list of functions programmatically from third party application or custom code, using API requests. These APIs would help you programmatically access, inserts, add, update and delete resources and effectively perform functions within CampaignsPlus. Before we move to discuss the available APIs, some important information is discussed in the following area. This information helps you understand the structure and parameters of API requests to perform any function without an error.

API Token/Key 

You need to have a valid API token for a successful API call. Whenever you make an API call, this token is used to authorize your account with CampaignsPlus. 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 the that holds the API token. Once clicked, system will generate a token for your account that you later will copy from here and will use in every API request you submit as an authorization token.

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/primary 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 and you can also provide a primary domain of your choice to mask CampaignsPlus provided installation URL. In both the cases, the URL part that may look like http://my.mumara.host or your own primary domain URL will remain the same in the API End Point, however the later part of the API End Point that would carry the function name will change for every API request and you may find its indication in all the sample requests listed under this help center section. 

Method

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