Comment utiliser l'API de Cyberimpact

À propos de l'API de Cyberimpact

Découvrez :

Qu'est-ce que l'API ?

Vous vous demandez ce qu’est un API ? Non, ce n’est pas le nom d’un droïde dans le nouveau film de Star Wars. L’API vous permet plutôt de faire interagir un système externe avec Cyberimpact (par exemple : votre site Web, un CRM, etc.) et de réaliser certaines fonctions par programmation. Une fois l’API en place, vous pouvez donc, entre autres, ajouter ou désabonner des contacts de manière automatique.
 

À quoi sert l'API de Cyberimpact ?

Cet outil vous permet, en autres, de :

  • Récupérer, désabonner, créer*, modifier et supprimer des contacts;
  • Ajouter des contacts à un groupe ou mettre à jour leurs groupes;
  • Récupérer, créer, modifier ou supprimer des groupes**;
  • Vider les contacts d'un groupe;
  • Récupérer, créer ou annuler des envois;
  • Récupérer, créer, remplacer ou supprimer des modèles;
  • Récupérer, importer ou désabonner plusieurs contacts à la fois.

*Si vous utilisez l'API pour ajouter des contacts dans votre compte, vous pourriez créer un scénario de bienvenue via le Marketing automatisé pour leur envoyer automatiquement un courriel suite à leur abonnement. Par exemple, vous pourriez leur envoyer un remerciement pour leur inscription à votre liste de diffusion.

**Un groupe interagissant avec l'API ne pourra pas être supprimé. Vous devrez donc reprogrammer votre requête avant de pouvoir supprimer le groupe de votre dossier.
 

Connaissances requises pour utiliser l'API

L'utilisation de l'API requiert des connaissances techniques en programmation

Si vous ne disposez pas d'une telle ressource, il est possible d'utiliser Zapier pour connecter facilement vos applications préférées avec Cyberimpact. En savoir plus sur Zapier >
 

Obtenir la documentation de l'API

La documentation de l'API est disponible ici.
 

Est-ce que tous les comptes peuvent utiliser l'API ?

L'API est accessible à tous les comptes, peu importe leur forfait. Son utilisation ne nécessite aucune permission spéciale. Veuillez cependant prendre note que l'ajout de contacts pourrait avoir un impact sur le prix de votre mensualité.
 

Ajouter des contacts via l'API 

Que souhaitez-vous faire ?

Ajouter des contacts uniques

Pour ajouter des contacts uniques, un à la fois, vous pouvez utiliser la fonctionnalité Opt-in a member ou Add a new member.

L'ajout de contacts par les méthodes Opt-in a member et Add a new member est limité. Pour ajouter un grand nombre de contacts simultanément, utilisez plutôt Add a batch.

Opt-in a member

Il s'agit de la méthode recommandée pour connecter un formulaire d'abonnement personnalisé à votre compte Cyberimpact. Cette option permet de valider l'adresse courriel et d'obtenir des preuves de consentement qui seront automatiquement enregistrées dans le détail de vos contacts. Elle peut mettre à jour également un contact déjà existant. L'utilisation d'un CAPTCHA avec votre formulaire est recommandée. 
En savoir plus > 

Add a new member

Cette option permet d'ajouter un nouveau contact directement dans votre compte sans lui demander de valider son adresse. Par exemple, vous pourriez ajouter l'adresse d'un nouvel acheteur sur votre boutique en ligne. Elle n'est cependant pas recommandée pour lier un formulaire d'abonnement à votre compte, car vous n'obtiendrez pas de preuve de consentement de cette manière. Notez également qu'il n'est pas possible de mettre à jour un contact déjà existant avec cette fonctionnalité. Vous devrez plutôt utiliser l'option Edit a member, Replace a member et/ou Add groups to member.
En savoir plus >
 

Importer une liste de contacts

Pour importer une liste de plusieurs contacts, utilisez la fonction Add a batch.

Add a batch

Cette fonction permet d'importer une grande liste de contacts ou de désabonner plusieurs adresses simultanément. Par exemple, une fois par jour, vous pourriez synchroniser votre CRM à votre compte Cyberimpact pour importer l'ensemble des adresses de vos clients.
En savoir plus >
 

Comment se connecter à l'API

Pour s'authentifier à l'API, vous invitons à utiliser les jetons d'API. Pour créer un jeton d'API, voici comment faire :

  1. Connectez-vous à votre compte Cyberimpact.
     
  2. Allez au menu Icone Développeurs > Jetons d'API .
     
  3. Cliquez sur + Créer un nouveau jeton d'API.
     
  4. Dans la fenêtre Jeton d'API, cliquez sur Copier dans le presse-papier.
    Utilisez ensuite ce jeton dans l'en-tête HTTP Authorization pour vos appels à l'API.
Partagez votre jeton d'API de façon sécuritaire et qu'avec des personnes en qui vous avez confiance. Votre jeton d'API est ce qui permet d'accéder à votre compte, il ne faut donc pas que cette information soit publique.

Notes importantes :

  • Chaque jeton d'API est valide pour une durée de 10 ans. Pour empêcher un jeton de fonctionner avant la fin de cette période, vous devrez le supprimer. Pour ce faire, connectez-vous au compte Cyberimpact, puis allez au menu Icone Développeurs > Jetons d'API. Ouvrez le menu Icone Actions situé à la droite du jeton à annuler et sélectionnez Supprimer. Puis, confirmez l'action. 
     
  • Un jeton d'API ne permet pas de s'authentifier dans l'application.
     
  • La connexion à l'API directement en JavaScript n'est présentement pas supportée. (En savoir plus sur la politique "Same-origin", en anglais)
     
  • Si vous utilisez l'ancienne méthode d'authentification à l'API (nom d'usager et mot de passe), nous vous recommandons fortement de passer à la nouvelle méthode qui utilise les jetons d'API. Ceci diminuera considérablement le temps nécessaire pour faire vos appels à l'API. De plus, cela évitera que des problèmes de connexion surviennent suite au changement du mot de passe de l'usager. L’authentification par jeton fonctionne selon le standard JWT (JSON Web Token), nous vous invitons à en apprendre plus à ce sujet ici (en anglais).

    Exemple en PHP :

    - Ancienne méthode :
    curl_setopt($curl_handle, CURLOPT_USERPWD, 'my_username' . ':' . 'my_password');

    - Nouvelle méthode :
    curl_setopt($curl_handle, CURLOPT_HTTPHEADER, array('Authorization: Bearer token-content'));
     
  • Pour assurer la bonne continuité du fonctionnement de votre programmation avec l'API :

    - lorsque vous utilisez la méthode d'authentification à l'API avec les jetons d'API, il serait important de ne pas supprimer le jeton utilisé dans votre programmation. Veuillez prendre note qu'avec cette méthode d'authentification, si vous supprimez l'usager qui a créé le jeton d'API, le jeton va continuer de fonctionner, même si l'usager n'existe plus.

    - lorsque vous utilisez la méthode d'authentification à l'API avec le nom d'usager et mot de passe, il serait important de ne pas supprimer ou modifier les codes d'accès de l'usager.
     

Besoin d'aide avec l'API

Des questions concernant l'API? Cliquez ici pour nous envoyer votre demande d'aide. Lors de l'envoi de votre question, assurez-vous de nous faire parvenir la requête HTTP complète (incluant le header (sauf votre jeton), le body et la réponse obtenue par notre API) afin que nos développeurs puissent reproduire votre cas d'utilisation dans son intégralité.

Nous vous invitons également à parcourir les exemples disponibles dans la documentation de notre API.
 

Voir aussi :

Haut