MasterBase® API
Learn from our APIs
To construct the URL of the service you wish to consume, you must do so with the following structure:
Base URL that groups the Web services:
https://api2023.masterbase.com
to which you must first add the segment indicating the service to which it points and then the optional parameters that define your query in question. The first of these is preceded by a question mark (?), followed by an equals sign (=) and the value of the parameter. From the second parameter you need to add, you must use the ampersand sign (&) instead of the question mark.
Example:
https://api2023.masterbase.com/contacts/v2/ClientName/?From=123&Top=100&Order=1
Structure
The Envelope
Every response is contained in a structure called a envelope (envelope, wrapper). This means that each response has a predefined structure with which you can interact.
{
"Service": "Service name",
"Version": "Version of the service",
"TransactionId": "Alphanumeric transaction identifier",
"Status": {
"Code": "Response code", "Code": "Response code", "Value": "Response value",
"Value": "Value of the response."
},
"Data": {}
}
Status
The key status is used to obtain information about the response of the service. If everything has run its course correctly, the response will indicate in the Code attribute the value 200 or 201. However, it may happen that something goes wrong, in which case the response obtained is of this type:
"Status": {
"Code": "401",
"Value": "Unauthorized"
}
Authentication
For the consumption of the web services available on this site, it is necessary to consider that access authentication is basic and for this purpose API Credentials are used -user and password- which are obtained through your MasterBase® account. The use of these will depend on the language chosen for the consumption of the services and is the responsibility of the user.
Access to the MasterBase® APIs consumption guide
Contacts - Manage your contacts
API that makes it possible to synchronize the contact data stored in your internal systems with those of your databases in MasterBase®.
MassiveMail - Manage your mailings
API that allows you to create messages and send mass mailings without having to log in to the MasterBase® platform.
UniqueMail - Manage your unique mailings
APIs that allow one-time shipments from internal systems without the need to log into the MasterBase® platform.
Archive - URL storage of individual campaigns
API for uploading and downloading files to and from the MasterBase® cloud for mass mailings
Config - Query configuration data
API to obtain information from the fields of each database.
Access to MasterBase® Process Automation APIs
Process Automation - WS RDS
API that enables remote management of records in an RDS data collection.
Automation - WS File Bunker
API allowing file storage in a web environment