Pour créer l'URL du service que vous souhaitez utiliser, vous devez respecter la structure suivante :

URL de base regroupant les services web :

à laquelle tu dois ajouter, tout d'abord, le segment indiquant le service vers lequel elle pointe, puis les paramètres facultatifs qui définissent ta requête. Le premier d'entre eux doit être précédé d'un point d'interrogation (?), suivi d'un signe égal (=) et de la valeur du paramètre. À partir du deuxième paramètre que vous devez ajouter, vous devrez utiliser le signe « et commercial » (&) à la place du point d'interrogation.

Exemple :

Structure

L'enveloppe

Chaque réponse est contenue dans une structure appelée « envelope » (enveloppe). Cela signifie que chaque réponse possède une structure prédéfinie avec laquelle il est possible d'interagir.

{
  "Service" : "Nom du service",
  "Version" : "Version du service",
  "TransactionId" : "Identifiant alphanumérique de la transaction",
  "Status": {
    "Code": "Code de la réponse",
    "Value": "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. Il peut toutefois arriver qu'une erreur se produise, auquel cas la réponse obtenue sera du type suivant :

{
  "Status": {
    "Code": "401",
    "Value": "Non autorisé"
  }
}

Authentification

Pour utiliser les services web disponibles sur ce site, il faut savoir que l'authentification d'accès est basique et qu'elle s'effectue à l'aide des identifiants API (nom d'utilisateur et mot de passe), que vous pouvez obtenir via votre compte MasterBase®.

Leur utilisation dépendra du langage choisi pour l'utilisation des services et relève de la responsabilité de celui qui les utilise.