Différences entre versions de « NF13075 — Interface de programmation applicative par Webservice (API) »
| Ligne 10 : | Ligne 10 : | ||
== Choix techniques == | == Choix techniques == | ||
=== Pour commencer === | === Pour commencer === | ||
| + | |||
| + | Notre API est bâtie sur l'exploitation d'un webservice, donc sur un échange HTTP pour lequel nous respectons le standard 1.1. | ||
| + | Elle est compatible notamment avec les échanges sécurisés (SSL). | ||
| + | |||
| + | Pour échanger avec notre webservice, il faut donc le faire à travers un client HTTP traditionnel en manipulant des URI. | ||
| + | |||
| + | L'API est ouverte et accessible sur l'URL suivante : https://''xx.xx.xx.xx'':''3443'''''/core/api/'''. | ||
| + | |||
=== Méthodes d'accès à l'API === | === Méthodes d'accès à l'API === | ||
Version du 29 septembre 2017 à 15:25
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
Notre API est bâtie sur l'exploitation d'un webservice, donc sur un échange HTTP pour lequel nous respectons le standard 1.1. Elle est compatible notamment avec les échanges sécurisés (SSL).
Pour échanger avec notre webservice, il faut donc le faire à travers un client HTTP traditionnel en manipulant des URI.
L'API est ouverte et accessible sur l'URL suivante : https://xx.xx.xx.xx:3443/core/api/.