Aller au contenu principal

Utiliser les webservices

Actito vous permet d'interagir avec ses données par le biais d'une API de type REST. Celle-ci vous permet d'effectuer diverses opérations de création, de mise à jour et de suppression.

Cette page vous renseigne sur le fonctionnement et les contraintes liées à cette API.

Méthodes utilisées dans les webservices​

Les opérations disponibles via les webservices Actito sont regroupées en 5 méthodes qui ont chacune leurs fonctionnalités propres : GET, PUT, POST, PATCH et DELETE

La méthode GET​

Cette méthode récupère une représentation de la ressource sur laquelle est basée la requête. Il s'agit d'une méthode de lecture seule, c'est à dire que l'appliquer sur une ressource ne résulte pas en un changement d'état de la ressource. C'est donc une méthode sûre.

Elle permet principalement d'extraire des informations depuis Actito, soit pour les traiter par vos autres systèmes (profils, campagnes existantes, ...), soit pour obtenir des informations structurelles dans le but de faciliter l'implémentation des autres méthodes (obtenir la structure d'une base de données, ...)

La méthode POST​

Cette méthode permet de créer une ressource dans la collection de ressources, en utilisant les données introduites dans le corps de la requête.

Elle est principalement utilisée pour la création de nouveaux éléments, mais elle peut aussi parfois être utilisée dans le cas de leur mise à jour.

La méthode PUT​

Cette méthode permet de remplacer la représentation d'une ressource en utilisant les données introduites dans le corps de la requête, ou de créer une nouvelle ressource si celle-ci n'existe pas encore.

Elle est principalement utilisée pour la mise à jour d'éléments, mais son comportement implique qu'elle puisse aussi parfois être utilisée pour activer des ressources, en mettant à jour leur statut.

La méthode PATCH​

Cette méthode est utilisée pour faire une mise à jour partielle d'une ressource existante. Contrairement à la méthode PUT qui remplacera l'ensemble de la ressource, les routes PATCH sont utiles pour seulement mettre à jour des paramètres spécifiques d'une ressource, sans affecter les autres paramètres.

La méthode DELETE​

Cette méthode supprime toutes les représentations d'une ressource.

Il peut s'agir de supprimer un élément précis (désabonner un profil d'un abonnement) ou un élément plus général (supprimer un profil ou un e-mail en définition).

Format des webservices​

Les APIs d'Actito supportent le format JSON et le format XML. Tous les bodies de réponse, et les bodies des appels faits avec les méthodes POST, PUT et PATCH doivent utiliser ce format, à moins que cela soit explicitement spécifié.

Si vous êtes peu familier avec ce format, il vous est possible de valider votre code avec l'aide du site suivant : https://jsonlint.com/

Utilisation optimale des webservices​

Afin de garantir une utilisation optimale des webservices, certaines frontières d'utilisation ont été mises en place :

  • Nombre maximum d'utilisateurs webservices par licence : 5

  • Nombre maximum d'appels par minute : 100

  • Nombre maximum d'appels de masse par jour : 12

  • Nombre maximum de requêtes simultanées par licence : 5

  • Taille maximum du fichier zippé pour un appel de masse : 100 Mo

Le dépassement de ces seuils conduira à une erreur ou à un ralentissement des performances.