I. Qu'est-ce qu'une API?
II. Pourquoi des REST API
1. Une plateforme ouverte
2. Des cas d'usage pertinents
a. Intégrer la donnée depuis vos systèmes d'information
b. Nourrir vos sites d'e-commerce
III. Vue d'ensemble de la documentation Swagger de nos API
1. Méthodologie
2. Authentification
3. Permissions
Une API, pour "Application Programming Interface", est un ensemble de définitions et de protocoles qui facilite la création et l'intégration de logiciels d'applications. Elles permettent d'utiliser les ressources, données ou fonctionnalités, d'une application web depuis une autre application.
Une API REST (également appelée API RESTful) est une interface de programmation d'application qui respecte les contraintes du style d'architecture REST et permet d'interagir avec les services web RESTful. L'architecture REST correspond à un acronyme anglais qui signifie "Representational State Transfer". Les REST API sont de plus en plus utilisées, car elles fonctionnent de la même manière que le reste du web.
Les REST API de Trace One sont la réponse à vos besoins d'interopérabilité, d'intégration et d'automatisation de la donnée.
Elles permettent de synchroniser vos référentiels (produits, fournisseurs, marques...) mais également de diffuser vos informations produits sur divers canaux d'échange et bien d'autres choses, et vous garantissent un accès fiable et sécurisé à vos données et une source unique de données.
Elles vous aident à améliorer le travail d'équipe, le partage d'information et l'automatisation de vos processus autour de la donnée en systématisant et structurant l'échange d'information.
Les solutions Trace One s'inscrivent dans une logique d'intégration parfaite au sein des systèmes d'information utilisés par nos clients. La synchronisation des données étant essentielle afin de tirer le meilleur parti des synergies possibles entre logiciels et délivrer de la valeur :
Interface uniforme avec les standards du marché : Conformément au style d'architecture REST, qui s'est aujourd'hui imposé comme un standard pour la simplicité d'utilisation et de maintenance, nos API abordent une interface uniforme adaptée à ce dernier. Cela permet notamment d'assurer la parfaite communication entre les applications issues de systèmes différents via le protocole standard HTTP. La standardisation REST assure également une intégration pérenne et de la stabilité dans le temps puisque les mises à jour sont versionnées pour permettre de continuer à utiliser librement une version donnée de nos API, et de migrer vers la nouvelle version au moment voulu.
Optimisation des opérations : Nos API REST permettent une séparation claire entre le système d'information du client et le serveur Trace One afin d'optimiser les opérations. Le client s'occupe uniquement de la récupération et de l'affichage de l'information (ou des données) et Trace One se concentre sur le stockage et la manipulation des données pour une meilleure efficience.
Sécurité et contrôle des échanges de données : Nos API permettent une mise à disposition de l'information de nos clients de manière sécurisée puisqu'elles sont protégées par le standard OAuth2, qui est aujourd’hui le plus approprié et le plus répandu dans le cadre d’API REST. Il s’agit d’un standard de délégation d’autorisation qui permet à une application d’obtenir l’autorisation d’accès à une ressource (API) au nom d’un utilisateur.
Vitesse et flexibilité : En plus d'être gratuitement mises à disposition, nos API sont extrêmement rapides à synchroniser et très flexibles pour s'adapter à la communication avec les différents référentiels issus de différentes solutions. De l'authentification aux requêtes, elles permettent l'industrialisation agile de l'échange d'informations.
Par ailleurs, dans un contexte métier très gourmand en données avec des consommateurs toujours plus demandeurs d'information produit, une accélération des nouvelles tendances du marché et une réglementation qui évolue, l'accès facile et rapide à vos données est devenu un enjeu essentiel.
Les API constituent une réponse pertinente à ces nouveaux besoins, tant elles jouent un rôle élémentaire de connecteur permettant de faire communiquer différents systèmes et logiciels complexes.
En facilitant l'accès à la donnée aux utilisateurs et sa manipulation, ces derniers peuvent plus aisément contrôler la bonne traçabilité et sûreté des produits. Une information fluidifiée permet une meilleure communication en interne, avec les partenaires et prestataires, mais également avec les clients finaux.
Les solutions Trace One peuvent s'intégrer facilement avec vos systèmes de référentiels internes (références produits, marques, fournisseurs) afin de créer une synergie de donnée pour que les référentiels qu'ils contiennent puissent plus facilement et automatiquement alimenter vos bases de données au sein de nos logiciels et inversement puisque Trace One peut réversiblement mettre à jour vos bases de données.
Aujourd'hui, les consommateurs cherchent à obtenir des informations sur les produits qu'ils achètent. Les informations importantes sont visibles sur les sites de e-commerce de la grande distribution pour permettre aux clients de faire leur choix au moment de l'achat. De plus en plus d'applications apparaissent pour évaluer les produits en fonction de ces informations.
L'API REST Trace One permet de constamment disposer d'informations d'étiquetage à jour sur les sites d'e-commerce au gré des améliorations de produits. Pour les produits à marque de distributeur, leurs mises à jour sont visibles dans les solutions Trace One.
En mettant à disposition des clients distributeurs différentes API REST, Trace One permet un accès facile à toutes les informations utiles à la collecte et à l'analyse de la donnée, afin de leur permettre de les comparer facilement avec celles des marques nationales.
Pour en savoir plus sur nos API, vous pouvez dès maintenant consulter la documentation Swagger intégralement mise à disposition dans le chapitre suivant ci-dessous.
Dites adieu à la pagaille des feuilles de calcul et faites voyager toutes vos informations sur les produits et vos autres référentiels en un seul endroit.
Profitez à la fois d'une meilleure communication en évitant des boucles d'e-mails contre-productives, et d'une capacité d'autonomie accrue en ayant facilement accès à toute la donnée que vous pourriez avoir besoin de collecter.
Choisissez les informations que vous souhaitez faire voyager entre vos systèmes et les solutions Trace One pour une capacité d'import et d'export des référentiels de donnée optimisée.
Nous avons fait le choix de Swagger comme support ouvert pour fournir la documentation de nos API. Sous cette forme, l'usage de nos API au format JSON est clair et lisible.
Si vous souhaitez commencer à utiliser ces API, rendez-vous sur l'URL suivante : https://ui-api-catalogs.traceone.com/swagger/index.html
Vous pouvez contacter votre Customer Success Manager qui pourra vous aider sur la suite du processus.
Pour pouvoir vous authentifier, vous aurez besoin de renseigner des paramètres que vous pouvez notamment obtenir auprès de votre contact Customer Success de Trace One.
Voici les paramètres dont il est question :
client_id: vous pouvez obtenir cette information auprès de votre contact privilégié chez Trace One.
client_secret: vous pouvez obtenir cette information auprès de votre contact privilégié chez Trace One.
grant_type: client_credentials
Voici un exemple d'utilisation oAuth (site en anglais) pour obtenir un token (jeton d'accès).
https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/
Une fois que vous avez le token, vous devez le placer dans l'en-tête d'autorisation de toutes les requêtes que vous effectuez comme présenté ci-après :
Authorization: Bearer <token>
Inscrivez vous à nos newsletters
Recevez les dernières informations sur l'actualité de la grande distribution et des industriels de PGC