La principal ventaja de las APIs en MasterBase® radica en que permiten automatizar acciones que en la plataforma web se realizan en forma manual.
Entre otras cosas, hacen posible:
Actualizar tus bases de datos en tu ambiente de trabajo y en nuestra plataforma, simultáneamente
Crear y enviar mensajes desde tus sistemas sin que debas ingresar a nuestra plataforma.
Recibir desde MasterBase® las métricas de tus envíos
MasterBase® API
Aprende de nuestras APIs
Para construir la URL del servicio que deseas consumir, debes hacerlo con la siguiente estructura:
URL base que agrupa los servicios Web:
https://api2023.masterbase.com
a la que debes agregar, en primer lugar, el segmento que indica el servicio al que apunta y, a continuación, los parámetros opcionales que definen tu consulta en cuestión. El primero de ellos antecedido por un signo de interrogación (?), seguido por un signo igual (=) y el valor del parámetro. Desde el segundo parámetro que necesites añadir, deberás utilizar el signo ampersand (&) en lugar del signo de interrogación.
Ejemplo:
https://api2023.masterbase.com/contacts/v2/ClientName/?From=123&Top=100&Order=1
Estructura
The Envelope
Toda respuesta está contenida en una estructura denominada envelope (sobre, envoltorio). Esto significa, que cada respuesta tiene una estructura predefinida con las cuales se puede interactuar.
{
"Service": "Nombre del servicio",
"Version": "Version el servicio",
"TransactionId": "Identificador alfanumerico de transaccion",
"Status": {
"Code": "Codigo de la respuesta",
"Value": "Valor de la respuesta"
},
"Data": {}
}
Status
La llave status se utiliza para obtener información acerca de la respuesta del servicio. Si todo ha seguido su curso en forma correcta, la respuesta indicará en el atributo Code el valor 200 o 201. Sin embargo, puede ocurrir que algo falle, en cuyo caso la respuesta que se obtendrá es de este tipo:
"Status": {
"Code": "401",
"Value": "Unauthorized"
}
Autenticación
Para el consumo de los web services que se disponen en este sitio, es necesario considerar que la autenticación de acceso es básica y para ello se utilizan las Credenciales API –usuario y contraseña– las cuales se obtienen a través de tu cuenta MasterBase®. El uso de éstas dependerá del lenguaje escogido para el consumo de los servicios y es de responsabilidad de quien realice dicho consumo.