API - Cyberimpact

API

API
Dernière mise à jour: 13 janvier 2017, 16:03

Dans cet article :

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 membres de manière automatique

À quoi sert l'API?

Cet outil vous permet, en autres, de :

  • Récupérer, désabonner, créer*, modifier et supprimer des membres;
  • Ajouter des membres à un groupe ou mettre à jour leurs groupes;
  • Récupérer, créer, modifier ou supprimer des groupes;
  • 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 membres à la fois.

*Si vous utilisez l'API pour ajouter des membres dans votre compte en utilisant le "double opt-in" (la personne reçoit un courriel de confirmation et clique sur le lien pour confirmer son inscription), vous pourriez utiliser la règle d'abonnement de l'autoréponse pour leur envoyer automatiquement un courriel suite à la confirmation de leur inscription. 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 reprogrammé votre requête avant de pouvoir supprimé le groupe de votre dossier.

Quelles sont les connaissances requises pour utiliser l'API?

Veuillez prendre note que cette fonction requiert des connaissances techniques en programmation.

Où peut-on trouver la documentation de l'API?

Pour obtenir la documentation de l'API, cliquez ici.

Note : Si vous avez besoin de revoir la documentation de la version précédente de l'API (V3), nous vous invitons à communiquer avec le service à la clientèle en envoyant votre requête par courriel à l'adresse : support@cyberimpact.com

Où faire la demande pour utiliser l'API?

Pour utiliser l'API, nous devrons activer la fonction dans votre compte. Pour faire activer cette fonction, veuillez nous envoyer votre demande par courriel à l’adresse suivante : support@cyberimpact.com. La demande doit provenir du contact technique ou de facturation du compte. N'oubliez pas dans votre requête d'ajouter le nom de l'entreprise et/ou du compte en question.

Comment faire pour 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. Assurez-vous que l'option vous permettant d'utiliser l'API a été activée pour votre compte. Pour faire activer cette fonction, veuillez nous envoyer votre demande par courriel à l’adresse suivante : support@cyberimpact.com. La demande doit provenir du contact technique ou de facturation du compte.

    Note : Cette étape est essentielle. Attendez de recevoir la confirmation que l'option a été activée avant de passer à l'étape suivante. L'option vous permettant de créer des jetons d'API ne s'affichera pas dans votre compte si l'autorisation d'utiliser l'API n'a pas été préalablement activée.
     
  2. Ensuite, connectez-vous à votre compte Cyberimpact.
     
  3. Pointez votre souris sur le menu "Configuration" et choisissez "Des jetons d'API".
     
  4. Cliquez sur "Créer un nouveau jeton d'API". Un nouveau jeton sera automatiquement créé.
     
  5. Cliquez sur le bouton "Visualiser"  à la droite du jeton.
     
  6. Copiez ensuite le contenu du jeton. Utilisez ensuite ce jeton dans l'en-tête HTTP Authorization pour vos appels à l'API.
     

Notes importantes :

  • L'option pour créer des jetons d'API va apparaître dans la fiche de l'usager seulement si l'option vous permettant d'utiliser l'API a été préalablement activée à votre compte.
     
  • 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, connectez-vous au compte Cyberimpact, puis allez dans le menu "Configuration" > "Des jetons d'API". Cliquez sur le bouton Supprimer à la droite du jeton à annuler.
     
  • 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 (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 fournir la requête complète qui est à l'origine de votre question ainsi que la réponse de l'API afin que nos développeurs puissent reproduire votre cas d'utilisation dans son intégralité.

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

Nous joindre

Formulaire de contact