RestAPI Overview

Contraintes de base

  • L'API est conçue pour respecter les spécifications HTTP et RESTful. Par exemple, utilisez la méthode GET pour les requêtes de consultation et la méthode POST pour les requêtes de soumission. Si une requête n'utilise pas la méthode HTTP correspondante, une erreur sera renvoyée.
  • Sauf indication contraire, les paramètres doivent être encodés en UTF-8 et encodés en URL.

Centres de données et URLs de base

Centre de données URL de base
Singapour https://ma-api.engagelab.com
Virginie, États-Unis https://ma-api-usva.engagelab.com

Lors de l'utilisation de l'API REST, vous devez combiner l'URL de base sélectionnée avec le chemin spécifique de l'API pour obtenir l'adresse complète d'appel.

{URL de base}/{chemin de l'API}
              
              {URL de base}/{chemin de l'API}

            
Afficher ce bloc de code dans la fenêtre flottante

Méthode d'authentification

L'API REST EngageLab utilise la méthode d'authentification HTTP Basic Authentication : ajoutez Authorization dans l'en-tête HTTP :

Authorization: Basic ${base64_auth_string}
              
              Authorization: Basic ${base64_auth_string}

            
Afficher ce bloc de code dans la fenêtre flottante

Le base64_auth_string est généré selon l'algorithme suivant : base64(api_key:api_secret).

  • Le nom de l'en-tête est "Authorization", et la valeur est la paire "nom d'utilisateur:mot de passe" encodée en base64 (avec deux-points au milieu).
  • Pour l'API MA, le nom d'utilisateur correspond à l'APIKey, et le mot de passe correspond à l'APISecret. Veuillez configurer une source de données de type API pour obtenir l'APIKey et l'APISecret.
icon
Contactez-nous