Présentation technique des Webservices dans PMB
page précédentepage suivante

Architecture générale des webservices

L'API de PMB

Qu'est-ce que l'API de PMB

PMB propose une API qui regroupe des fonctions qui permettent notamment de (liste non exhaustive) :

  • Faire des recherches simples et multi-critères

  • Récupérer des notices dans différents formats

  • Obtenir les disponibilités des exemplaires

  • Récupérer les informations d'un emprunteur (adresse, prêts en cours, en retard, réservations)

  • Poser des réservations sur des notices

  • Ajouter des commentaires et tagger des notices

En un mot, toutes les fonctions nécessaires à une intégration de PMB dans une autre application.

Cette API est appelée Services externes dans PMB. L'administrateur de PMB choisit les fonctions qu'il autorise à utiliser dans l'API.

Comment utiliser cette API

L'API est une classe PHP qui propose sous forme de méthodes les fonctions de PMB que l'on a autorisé à utiliser. Cette classe est incluse dans des scripts PHP qui peuvent utiliser ces fonctions.

Export de l'API par les webservices

Une fois les services externes définis, PMB propose des webservices qui permettent d'appeler l'API à distance. Ces webservices implémentent des protocoles d'appel à distance de méthodes (Remote Procedure Call).

Deux protocoles sont implémentés : le protocole SOAP 1 via HTTP et le protocole JSON-RPC2 . Ces protocoles déterminent un format de données pour appeler une méthode de l'API, passer des arguments et récupérer une structure de données résultat.

Synthèse

PMB propose d'une API qui est un ensemble de fonctions utilisables dans des scripts PHP externes à PMB. Dans PMB, cette API est appelée Services externes.

PMB utilise les fonctions de cette API pour les exporter comme des méthodes appelables à distance via des protocoles normalisés SOAP et JSON-RPC. Ces protocoles utilisent le protocole HTTP comme protocole de transport, ce sont donc des webservices.

Architecture générale des webservices dans PMB
Architecture générale des webservices dans PMB
  1. Le protocole SOAP
    Le protocole SOAP

    Pour en savoir plus : présentation de SOAP et liens vers les spécifications techniques dans Wikipédia (en français).

  2. Le protocole JSON-RPC
    Le protocole JSON-RPC

    Description du protocole et liens vers des documentations techniques dans Wikipedia (en anglais).

page précédentepage suivante
A propos...PMB ServicesRéalisé avec Scenari