Para criar a URL do serviço que pretende utilizar, deve seguir a seguinte estrutura:

URL de base que agrupa os serviços Web:

à qual deve adicionar, em primeiro lugar, o segmento que indica o serviço ao qual se refere e, em seguida, os parâmetros opcionais que definem a sua consulta em questão. O primeiro deles deve ser precedido por um ponto de interrogação (?), seguido de um sinal de igual (=) e do valor do parâmetro. A partir do segundo parâmetro que precisar de adicionar, deverá utilizar o sinal de e comercial (&) em vez do ponto de interrogação.

Exemplo:

Estrutura

O Envelope

Todas as respostas estão contidas numa estrutura denominada «envelope» (envelope, invólucro). Isto significa que cada resposta tem uma estrutura predefinida com a qual é possível interagir.

{
  "Service": "Nome do serviço",
  "Version": "Versão do serviço",
  "TransactionId": "Identificador alfanumérico da transação",
  "Status": {
    "Code": "Código da resposta",
    "Value": "Valor da resposta"
  },
  "Data": {}
}

Estado

A chave estatuto é utilizado para obter informações sobre a resposta do serviço. Se tudo tiver decorrido corretamente, a resposta indicará no atributo Código o valor 200 ou 201. No entanto, pode acontecer que algo corra mal; nesse caso, a resposta obtida será do seguinte tipo:

{
  "Status": {
    "Code": "401",
    "Value": "Não autorizado"
  }
}

Autenticação

Para utilizar os serviços web disponíveis neste site, é importante ter em conta que a autenticação de acesso é básica e, para tal, são utilizadas as credenciais da API — nome de utilizador e palavra-passe —, que podem ser obtidas através da sua conta MasterBase®.

A utilização destas dependerá da linguagem escolhida para a utilização dos serviços e é da responsabilidade de quem efetuar essa utilização.