Vue d’ensemble 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, tandis que les requêtes de soumission utilisent la méthode POST. Si une requête n’utilise pas la méthode HTTP correspondante, une erreur est renvoyée.
• Sauf indication contraire, les valeurs des paramètres des requêtes doivent être encodées en UTF-8 à l’aide du codage URL.

Centre de données et URL de base

Lorsque vous utilisez l’API REST LiveDesk, combinez l’URL de base sélectionnée avec le chemin d’API spécifique pour obtenir l’URL complète de la requête.

              
              {base URL}/{API path}

            

Méthode d’authentification

L’API REST EngageLab utilise l’authentification HTTP Basic. Ajoutez l’en-tête Authorization à la requête HTTP :

              
              Authorization: Basic ${base64_auth_string}

            

L’algorithme permettant de générer base64_auth_string est le suivant :

              
              base64(api_key:api_secret)

            

• Le nom de l’en-tête est Authorization. Sa valeur correspond à la paire username:password, encodée en Base64 et séparée par deux-points.
• Dans le contexte de l’API LiveDesk, le nom d’utilisateur correspond à l’API Key et le mot de passe à l’API Secret. Ajoutez une source de données de type API dans Project Settings > API Management pour obtenir l’API Key et l’API Secret.