Aperçu de l'API REST

De base

• L'API est conçue pour être conforme aux spécifications HTTP et REST. Par exemple, la méthode GET est utilisée pour les requêtes de consultation et la méthode POST est utilisée pour les requêtes de soumission. Si une requête n'utilise pas la méthode HTTP correspondante, une erreur est renvoyée.
• Sauf indication contraire, la valeur du paramètre d'appel doit être encodée en UTF-8, Codage URL

Centres de données et URL de base

À partir du 19 mars 2025, les développeurs qui accèdent nouvellement à l'API Push d'Engagelab sont invités à utiliser le nom de domaine suivant. L'URL de base d'origine avec le suffixe .cc peut toujours être utilisée, mais il est conseillé aux développeurs de passer au dernier nom de domaine.

Lors de l'utilisation de l'API REST, il est nécessaire de combiner l'URL de base choisie avec le chemin spécifique de l'API pour obtenir l'endpoint complet.

              
              {URL de base}/{chemin API}

            

Ici, {URL de base} représente l'URL de base du centre de données sélectionné, et {chemin API} désigne le chemin d'endpoint spécifique de l'API, tel que v4/devices/{registration_id}.

Exemple :

• Supposons que le centre de données de Singapour soit choisi avec une URL de base https://webpushapi-sgp.engagelab.com.
• Si l'objectif est de supprimer les informations d'enregistrement d'un appareil spécifique, et que le chemin API est v4/devices/{registration_id}, alors l'endpoint API complet serait :

              
              https://webpushapi-sgp.engagelab.com/v4/devices/{registration_id}

            

Ici, {registration_id} représente l'ID d'enregistrement spécifique de l'appareil.

En utilisant cette approche, vous pouvez construire des URLs d'endpoint API complètes pour accéder à différents centres de données.

Méthode d'authentification

L'API REST d'Engagelab utilise l'authentification HTTP Basic La méthode de base consiste à ajouter l'en-tête HTTP Authorization (Header) :

              
              Authorization: Basic base64_auth_string

            

L'algorithme de génération de base64_auth_string est base64(appKey:masterSecret)
C'est-à-dire, ajouter un deux-points à l'appKey, ajouter la chaîne masterSecret assemblée, puis effectuer la conversion en base64
Rendez-vous sur la page des paramètres de l'application - informations de l'application pour obtenir les paramètres appKey et masterSecret

Exemple d'authentification

Si votre appKey est "c96f42e0d2e662e45d035ab1", et le masterSecret est "df4d59e84eac2f9d53b36f12", lorsque vous appelez l'API Push v4, utilisez la commande curl suivante :

              
               curl --insecure -X POST -v https://webpushapi-sgp.engagelab.com/v4/push 
-H "Content-Type: application/json" 
-u "c96f42e0d2e662e45d035ab1:df4d59e84eac2f9d53b36f12" 
-d '{"from":"push","to":"all","body":{"platform":"web","notification":{"alert":"Hi,MTPush !","web":{"alert":"Hi,MTPush !", "title":"web_push", "url":"http://www.google.com","extras":{"web-key1":"web-value1"}}}},"request_id":"12345678", "custom_args":"business info"}'

            

La requête HTTP est :

              
              > POST /v4/push HTTP/1.1
> Authorization: Basic Yzk2ZjQyZTBkMmU2NjJlNDVkMDM1YWIxOmRmNGQ1OWU4NGVhYzJmOWQ1M2IzNmYxMg==