The main advantage of the APIs in MasterBase® is that they allow automating actions that are performed manually in the web platform.
Among other things, they make it possible:
Update your databases in your work environment and on our platform simultaneously.
Create and send messages from your systems without having to log in to our platform.
Receive from MasterBase® your shipment metrics
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.
