Aperçu de l'API REST

Contraintes de base

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

Centre de données et URL de base

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 de l'appel.

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

            

Authentification

L'API REST EngageLab utilise l'authentification HTTP Basic : Ajoutez Authorization dans l'en-tête HTTP :

              
              Authorization: Basic ${base64_auth_string}

            

L'algorithme de génération du base64_auth_string ci-dessus est : 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 (séparée par un deux-points).
• Dans le contexte de l'API LiveDesk, le nom d'utilisateur correspond à la clé API et le mot de passe au secret API. Veuillez ajouter une source de données de type API dans "Paramètres du projet - Gestion des API" pour obtenir la clé API et le secret API.