To build the URL for the service you want to use, you should follow this structure:

Base URL that groups the Web services:

To which you must first add the segment that specifies the service it points to, and then the optional parameters that define your query. The first of these must be preceded by a question mark (?), followed by an equal sign (=) and the parameter value. Starting with the second parameter you need to add, you must use the ampersand (&) instead of the question mark.

Example:

Structure

The Envelope

Every response is contained within a structure called an "envelope." This means that each response has a predefined structure that you can interact with.

{
  "Service": "Service name",
  "Version": "Service version",
  "TransactionId": "Alphanumeric transaction identifier",
  "Status": {
    "Code": "Response code",
    "Value": "Response value"
  },
  "Data": {}
}

Status

The key status is used to obtain information about the service's response. If everything went according to plan, the response will indicate in the attribute Code the value 200 or 201. However, there may be a failure, in which case the response you receive will look something like this:

{
  "Status": {
    "Code": "401",
    "Value": "Unauthorized"
  }
}

Authentication

To use the web services available on this site, please note that access authentication is basic and requires API credentials—username and password—which can be obtained through your MasterBase® account.

The use of these will depend on the language chosen for accessing the services, and it is the responsibility of the user.