MasterBase® API
Tirer parti de nos API
Que sont les API MasterBase® et à quoi servent-elles ?
Pour construire l'URL du service que vous souhaitez consommer, vous devez le faire avec la structure suivante :
URL de base regroupant les services web :
https://api2023.masterbase.com
à laquelle vous devez d'abord ajouter le segment indiquant le service vers lequel elle pointe, puis les paramètres optionnels qui définissent votre requête en question. Le premier d'entre eux est précédé d'un point d'interrogation ( ?), suivi du signe égal (=) et de la valeur du paramètre. À partir du deuxième paramètre à ajouter, vous devez utiliser le signe de l'esperluette (&) à la place du point d'interrogation.
Exemple:
https://api2023.masterbase.com/contacts/v2/Nom du client/?De=123&Top=100&Ordre=1
Structure
L'enveloppe
Chaque réponse est contenue dans une structure appelée enveloppe (enveloppe, wrapper). Cela signifie que chaque réponse a une structure prédéfinie avec laquelle elle peut interagir.
{
"Service" : "Nom du service",
"Version" : "Version du service",
"TransactionId" : "Identifiant alphanumérique de la transaction",
"Status" : {
Code" : "Code de la réponse", "Code" : "Code de la réponse", "Valeur" : "Valeur de la réponse",
Valeur" : "Valeur de la réponse", "Valeur" : "Valeur de la réponse".
},
"Data" : {}
}
Statut
La clé statut est utilisé pour obtenir des informations sur la réponse du service. Si tout s'est déroulé correctement, la réponse indiquera dans l'attribut Code la valeur 200 ou 201. Cependant, il peut arriver que quelque chose se passe mal, auquel cas la réponse que vous obtiendrez sera de ce type :
"Statut" : {
"Code" : "401",
"Value" : "Unauthorized"
}
Authentification
Pour la consommation des services web disponibles sur ce site, il est nécessaire de considérer que l'authentification de l'accès est basique et, à cette fin, des API Credentials sont utilisés -utilisateur et mot de passe- qui sont obtenus par le biais de votre compte MasterBase®. L'utilisation de ces informations dépend de la langue choisie pour la consommation des services et relève de la responsabilité de l'utilisateur.
Accès au guide de consommation des APIs MasterBase
Contacts - Gérer vos contacts
API qui permet de synchroniser les données de contact stockées dans vos systèmes internes avec celles de vos bases de données dans MasterBase®.
MassiveMail - Gérez vos mailings
API qui vous permet de créer des messages et d'effectuer des envois en masse sans vous connecter à la plateforme MasterBase®.
UniqueMail - Gérez vos envois uniques
des API qui permettent d'effectuer des envois ponctuels à partir de systèmes internes sans avoir à se connecter à la plateforme MasterBase®.
Archive - Stockage URL de campagnes individuelles
API pour le chargement et le téléchargement de fichiers depuis et vers le nuage MasterBase® pour les envois de masse
Config - Visualiser les données de configuration
pour obtenir des informations sur les champs de chaque base de données.
Accéder aux API MasterBase® pour l'automatisation des processus
Automatisation des processus - WS RDS
API permettant la gestion à distance des enregistrements dans une collection de données RDS.
Automatisation - WS File Bunker
API qui permet le stockage de fichiers dans un environnement web.