Comment utiliser l'API publique de systeme.io (Interface de programmation d'applications)

Dans cet article, vous apprendrez à configurer et à utiliser l'API publique de systeme.io, notamment comment générer des clés API et quelles actions vous pouvez effectuer.

1. Qu'est-ce qu'une API ?

L'acronyme API signifie « Application Programming Interface » (interface de programmation d'application) ; il s'agit d'un ensemble d'instructions grâce auxquelles une plateforme propose ses services à d'autres plateformes. C'est une passerelle stratégique pour les développeurs externes, qui leur permet d'accéder à des fonctionnalités ou à des données spécifiques d'une plateforme de manière structurée et sécurisée. C'est en quelque sorte un ensemble d'outils prêts à l'emploi qui facilitent la création de nouvelles applications, de nouveaux services ou de nouvelles combinaisons.

En résumé, systeme.io s'ouvre à d'autres plateformes pour proposer ses services là où il apporte une valeur ajoutée.

2. Comment fonctionne notre API publique ?

Notre API propose un ensemble de fonctionnalités soigneusement sélectionnées, permettant aux développeurs d'interagir avec notre plateforme de manière transparente et efficace. Si vous souhaitez en savoir plus sur son fonctionnement, vous pouvez consulter notre documentation officielle sur l'API.

3. Comment générer vos clés API

Les clés API sont des identifiants uniques qui authentifient les requêtes adressées à notre API publique. Elles vous permettent d'accéder à diverses ressources de notre plateforme et de les gérer par programmation.

Pour créer une clé API publique, cliquez sur votre photo de profil, sélectionnez "Paramètres" (1), puis faites défiler la page jusqu'à la section "Clés MCP et API" (2).

Cliquez sur "Créer" (3) pour générer une nouvelle clé API publique

Dans la popup "Créer une clé API publique", saisissez un nom, puis sélectionnez une date et une heure d'expiration pour votre clé API.

Une fois que vous avez terminé, cliquez sur "Sauvegarder" (4).

Pour choisir une date et une heure d'expiration précises, sélectionnez-les dans le calendrier, puis cliquez sur "Appliquer".

Remarque : pour que votre clé API reste active indéfiniment, ne remplissez pas le champ « Date d'expiration ».

Une fois votre clé API créée, copiez immédiatement votre jeton, car vous ne pourrez plus le consulter par la suite. Pour copier votre jeton, cliquez sur l'icône « Copier » située à gauche du jeton :

Voici comment s'affiche un jeton une fois qu'il n'est plus visible :

4. Que pouvez-vous faire avec notre API ?

Notre API offre des possibilités intéressantes. Vous trouverez ci-dessous les principales actions que vous pouvez effectuer à l’aide de notre API publique :

a. Contacts, tags et champs personnalisés :

• Gérer les contacts : créer de nouveaux contacts, mettre à jour ceux qui existent déjà, lister votre audience à l’aide de filtres avancés ou supprimer des contacts.
• Gérer les tags : créer, attribuer, lister et supprimer des tags de vos contacts.
• Champs personnalisés : récupérer les champs personnalisés disponibles pour les contacts et leurs identifiants (slugs) afin de renseigner correctement les informations de contact.

b. Newsletters :

• Créer et mettre à jour des newsletters : créer de nouveaux brouillons de newsletters ou modifier partiellement ceux qui existent déjà. Vous pouvez définir le type d'éditeur (Classique ou Visuel), récupérer le contenu HTML complet et définir explicitement le nom et l'adresse email de l'expéditeur.
• Répertorier et récupérer : parcourir vos newsletters existantes ou récupérer le contenu complet d'une newsletter spécifique à l'aide de son identifiant.

c. Tunnels de vente et éditeur de pages :

• Gestion des tunnels de vente : créer de nouveaux tunnels, y ajouter de nouvelles étapes (pages) et récupérer la liste de toutes les étapes individuelles d’un tunnel spécifique.
• Éditeur de pages : enregistrer le contenu généré directement dans les étapes de vos tunnels ou sur les pages de votre site web (remplacement complet), et récupérer les schémas JSON pour des types de pages spécifiques.

d. Formules tarifaires et bons de réduction :

• Créer, modifier et supprimer : générer de nouvelles formules tarifaires et de nouveaux bons de réduction, ou mettre à jour partiellement et supprimer ceux qui existent déjà.
• Liste et recherche : parcourir l’ensemble de vos formules tarifaires et bons de réduction existants, ou récupérer des éléments spécifiques à l’aide de leur identifiant.

e. Formations et étudiants :

• Gérer les formations et les étudiants : récupérer la liste de vos formations existantes et celle des étudiants actuellement inscrits.
• Inscrire des étudiants : inscrire par programmation des contacts à vos différentes formations.

Remarque concernant les cours : la prise en charge des packs de formations sera ajoutée dans les prochaines mises à jour

f. Communautés :

• Gérer les communautés : récupérer la liste de vos communautés existantes et accéder à la liste des membres actuels d’une communauté spécifique.
• Inviter des membres : inviter par programmation de nouveaux utilisateurs à rejoindre vos communautés en fournissant leur identifiant de contact.

g. Règles d’automatisation :

• Gérer les règles : associer par programmation des événements et des actions courants, mettre à jour des règles existantes (par exemple, en modifiant une action tout en conservant le même déclencheur) ou supprimer temporairement des règles.
• Répertorier et récupérer : parcourir vos règles d’automatisation ou récupérer une règle spécifique à l’aide de son identifiant.

h. Abonnements :

• Gérer les abonnements : récupérer la liste de toutes les ressources d’un abonnement provenant de plateformes tierces, et résilier un abonnement soit immédiatement, soit à la fin du cycle de facturation.

i. Webhooks

• Gérer les webhooks : créer par programmation de nouveaux webhooks pour recevoir des notifications en temps réel, récupérer la liste de vos webhooks existants et supprimer ceux qui ne sont plus nécessaires.

Note :

• Pour pouvoir identifier et gérer facilement vos jetons, chacun d'entre eux doit porter un nom unique.
• Un jeton ne peut être copié qu'immédiatement après sa création. Si vous avez oublié de copier votre jeton, supprimez-le et créez-en un nouveau.
• Par mesure de sécurité, nous vous enverrons une notification par email chaque fois qu'une nouvelle clé API publique sera créée sur votre compte systeme.io.
• Vous pouvez créer jusqu'à 3 clés API par compte.

Pour en savoir plus : Documentation de l'API