NF13075 — Interface de programmation applicative par Webservice (API)

De Documentation Polaris
Aller à : navigation, rechercher

Voir la carte de la fonctionnalité : Autres outils

L'API par Webservice vous permet de piloter ou d'interroger votre solution de gestion depuis un programme externe : c'est par son intermédiaire que le prestataire tiers choisi va mettre en place l'interconnexion à votre backoffice. Cette documentation lui est donc principalement destinée.

En effet, une interface de programmation applicative (désignée par le terme API pour Application Programming Interface) est un ensemble normalisé de classes, de méthodes ou de fonctions qui sert de façade par laquelle un logiciel offre des services à d'autres logiciels.

Dans le cas de Polaris, elle est offerte par un service web, accessible sur chaque service de réplication.

Choix techniques

Pour commencer

Méthodes d'accès à l'API

Gestion de l'identification et des droits d'accès

Format des paramètres API

Gestion des réponses

Gestion des erreurs

Liste des fonctions accessibles