logoPage
logo fr ico logo en-us ico

Quelques raisons de doter son site d'une API Webservices

Cas de sites communautaires

Si vous possédez un site de type communautaire, l'intérêt de la mise en place d'une API est évident : PARTAGER VOS DONNEES.
Si vos données sont partagées et diffusées sur le web, la notoriété de votre site grandira et deviendra un lieu de visite important.

Si vous possédez un site d'envergure professionnel, les webservices peut s'avérer nécessaires, incontournables dans le cadre de la mise en place d'une politique de communication entre différents modules de votre système d'information.
Cette communication peut par exemple prendre la forme d'une communication entre le catalogue de produits en ligne et les webservices d'un logiciel de gestion permettant de maintenir à jour les bases de ce dit logiciel de gestion afin de simplifier et d'accélérer toutes les opérations de gestion/comptabilité.
Nicoweb se propose de vous conseiller sur la mise en place de telles architectures et de vous proposer la mise en place des dites architectures.

Description de la mise en place

Etude du modèle de données existant et création d'un schéma API

L'étude de votre modèle de données constitue la première étape de la mise en place d'une API Webservices.
Une fois ce modèle de données établi (ndr : voir fourni) la schématisation de l'API Webservices commence en fonction des besoins exprimés, en fonction des conseils/contraintes exprimées par Nicoweb .
Cette étape terminée, il reste à mettre en place les outils d'utilisation de l'API Webservices que cela soit sur le site web ou elle sera intégrée ou bien dans des modules spécialisés mis à disposition des webmasters et internautes sur le site (ndr : voir détails dans point 'Format des outils de diffusion').

Format des outils de diffusion

Présentation des différents formats proposés

Afin de permettre au monde entier de récupérer et utiliser les données issu de votre modèle, plusieurs types de module sont proposés.
Une liste non-exhaustive de modules est présentée ci après.
  • PHP : module basé PHP qui permet de récupérer les données de votre site dans un format intelligible par des développeurs PHP ou personne ayant une connaissance même faible du langage PHP.
  • Flex : module basé FLEX qui permet d'afficher vos données (ndr : médias possble => vidéo, musique) dans des fenêtres optimisées graphiquement.
  • JAVA : module permettant d'afficher des données provenant de votre API via des applets JAVA ou des modules graphiques basé SWING.

Création de widgets reliés à l'API Webservices

Description générale d'un widget

Un widget est littéralement en anglais un "windows gadget" soit un outil présenté sous forme de fenêtre/cadre qui permet des fonctionnalités semblables à celle des logiciels dits "desktop".
Les widgets sont essentiels dans l'architecture de l'API car sont les "points de sortie" de vos données. Ce sont ces widgets qui serviront à présenter le contenu que vous laissez accessible via votre API Webservices.

Format de widgets proposés par Nicoweb

Les widgets peuvent revêtir diverses apparences en raison de l'étendue des langages permettant d'en mettre au point.
Nicoweb vous propose en premier lieu des widgets XHTML/CSS/Javascript qui s'intègrent dans les pages de vos sites ou de ceux de vos visiteurs afin de présenter votre contenu.
Nicoweb vous propose également la mise en place de widgets JAVA (multplateformes) permettant d'utiliser vos données depuis des applications "desktop".
Enfin, avec l'arrivée de Windows Vista (édition le 21/02/2007) Nicoweb pourra prochainement proposer la création de widgets "taillés" pour Windows Vista et tirant profit des nouvelles fonctionnalités du système d'exploitation.

Documentation de votre API et de vos webservices

Structure XML de la documentation

Afin de vous permettre de disposer d'une documentation de votre API nous vous proposons d'utiliser un format XML pour créer votre base documentaire qui permettra autant à vos développeurs, qu'à vos membres/visiteurs d'utiliser efficacement votre API.
La structure XML vous permettra de contrôler plus efficacement la présentation de votre base documentaire ce qui n'est pas le cas lorsque sont utilisées des documentations au format Word, PDF ou autre.

La documentation d'une API est essentielle pour en permettre son utilisation.

Tous droits réservés à Mr Bertelle Nicolas .