L’API easyReco est une interface permettant à des développeurs extérieurs d’interagir directement avec easyReco sans utiliser tout ou partie de l'interface web du service.
Il est alors facile pour un développeur d’intégrer easyReco à une application web ou de bureau.
À qui s’adresse l’ API easyReco ?
Elle s’adresse aux entreprises qui souhaitent utiliser les technologies de la solution easyReco au travers de leurs outils, solutions et process, soit pour l'interne (interconnexion avec les ERP, solutions métier), soit pour l'externe (ajout de fonctionnalités spécifiques à la préparation, impression et suivi de courrier à des logiciels métiers...) et qui ont besoin de tout ou partie des fonctionnalités ou qui souhaitent les utiliser dans un autre contexte. L’API easyReco vous permet par exemple (liste non exhaustive) :
- De faciliter les opérations de préparation de vos collègues en envoyant directement vos données d'adresses et de références dans easyReco
- De rendre totalement automatique des actions habituellement réalisées par vos collègues en imprimant supports et bordereaux sans intervention humaine
- D’intégrer vos données easyReco dans votre application métier (CRM, ERP, application propriétaire...)
- De faire remonter les informations de suivi postal et les images d'accusé-réception afin d'intégrer l'aspect Traçabilité d'easyReco à vos outils
- D'intégrer à vos solutions la possibilité de préparer, imprimer et suivre des envois sans avoir besoin d'intégrer, faire agréer par les transporteurs et faire évoluer les spécifications de chacun des supports proposés
- De développer des connecteurs spécifiques
- De synchroniser vos contacts
- ...
Pour utiliser l'API easyReco, les développeurs devront être familiers avec les technologies conventionnelles du web.
Comment l’utiliser ?
L’API easyReco utilise des technologies conventionnelles permettant à tout développeur maitrisant les langages et méthodes usuels du web de travailler et réaliser des connecteurs ou applications. La manière d'utiliser l'API easyReco sera dépendante du type de projet que vous souhaitez réalisé et des pré-requis imposés par vos solutions et par l'API easyReco.
Pour utiliser l'API, il faut donc s'appuyer sur des équipes techniques compétentes, puis étudier l'ensemble de la documentation ici présente pour définir les contours de votre projet.
easyReco ne prend pas en charge le développement de vos applications et de vos connecteurs. En effet, nos équipes se consacrent principalement à l'amélioration continue de nos solutions. Néanmoins, selon la nature de votre projet, vous pouvez nous solliciter pour obtenir de l'assistance au développement : nous ferons alors le maximum pour vous proposer des solutions adaptées.
Technologies utilisées
L’API easyReco est écrite en PHP. Les fonctionnalités d'easyReco utilisables via l'API easyReco sont publiées sous forme de web service via des API en architecture REST.
Vous pouvez y accéder via des requêtes HTTPS. À chaque fonctionnalité correspond une URL. L'API easyReco utilise les méthodes GET, POST, PUT et DELETE.
Obtenir un accès API
Pour d'obtenir l'accès à l'API easyReco et commencer à developper votre application, vous devez contacter votre interlocuteur commercial easyReco afin de valider le périmètre de votre projet.
Dès lors, une clé API unique, liée à votre compte easyReco, vous sera transmise et vous permettra d'utiliser l'API easyReco (cette clé étant notamment nécessaire pour l'authentification).
Dans les options de votre compte (easyreco.com/mon-compte), vous pourrez consulter et si nécessaire générer une nouvelle clé API.
Utiliser l'API
Vous avez maintenant une première approche de l'API, consultez désormais la page Utilisation de la documentation afin de commencer à développer votre application.