API do MasterBase
Aprenda com as nossas APIs
O que são e para que servem as APIs MasterBase®?
Para construir o URL do serviço que pretende consumir, deve fazê-lo com a seguinte estrutura:
URL de base que agrupa os serviços Web:
https://api2023.masterbase.com
ao qual se deve acrescentar, em primeiro lugar, o segmento que indica o serviço para o qual aponta e, em seguida, os parâmetros opcionais que definem a consulta em questão. O primeiro deles é precedido de um ponto de interrogação (?), seguido de um sinal de igual (=) e do valor do parâmetro. A partir do segundo parâmetro a acrescentar, deve utilizar o sinal de E comercial (&) em vez do ponto de interrogação.
Exemplo:
https://api2023.masterbase.com/contacts/v2/ClientName/?De=123&Top=100&Ordem=1
Estrutura
O Envelope
Cada resposta está contida em uma estrutura chamada envelope (envelope, invólucro). Isto significa que cada resposta tem uma estrutura predefinida com a qual pode interagir.
{
"Serviço": "Nome do serviço",
"Version": "Versão do serviço",
"TransactionId": "Identificador alfanumérico da transação",
"Estado": {
Código": "Código de resposta", "Código": "Código de resposta", "Valor": "Valor da resposta",
"Value": "Valor 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 corrido corretamente, a resposta indicará no atributo Code o valor 200 ou 201. No entanto, pode acontecer que algo corra mal, caso em que a resposta que obterá será deste tipo:
"Estado": {
"Código": "401",
"Value" (Valor): "Unauthorized" (Não autorizado)
}
Autenticação
Para o consumo dos serviços web disponíveis neste site, é necessário considerar que a autenticação de acesso é básica e para isso são utilizadas Credenciais API -utilizador e palavra-passe- que são obtidas através da sua conta MasterBase®. A utilização das mesmas dependerá do idioma escolhido para o consumo dos serviços e é da responsabilidade do utilizador.
Acesso ao guia de consumo das APIs MasterBase®.
Contactos - Gerir os seus contactos
API que permite sincronizar os dados de contacto armazenados nos seus sistemas internos com os das suas bases de dados no MasterBase®.
MassiveMail - Gerir os seus envios
API que permite criar mensagens e efetuar envios em massa sem ter de entrar na plataforma MasterBase®.
UniqueMail - Gerir os seus envios de correio únicos
APIs que permitem efetuar envios pontuais a partir de sistemas internos sem necessidade de entrar na plataforma MasterBase®.
Arquivo - armazenamento URL de campanhas individuais
API para carregar e descarregar ficheiros de e para a nuvem MasterBase® para envios em massa
Config - Visualizar dados de configuração
API para obter informações dos campos de cada base de dados.
Acesso a APIs MasterBase® para automação de processos
Automatização de processos - WS RDS
API que permite a gestão remota de registos numa coleção de dados RDS.
Automatização - Bunker de ficheiros WS
API que permite o armazenamento de ficheiros num ambiente Web.