ONYX - 9.0 - Utilisation

Utilisation de ONYX Xpress

De MappingDoc
Révision datée du 13 février 2019 à 17:50 par imported>Gbarret (Liste et exemples de Webservices)
(diff) ← Version précédente | Voir la version actuelle (diff) | Version suivante → (diff)

Webservice REST

Cette page explique l'utilisation de l'applicatif ONYX Xpress.

Il s'agit d'un mode simplifié du grand ensemble M-Processing Server.

Les traitements sont accessibles à travers des WebServices qui suivent les conventions REST.

Traitements disponibles à travers les Webservices

Si l'on considères les fonctionnalités de M-PS accessible à travers les services Xpress, on peut lister :

  • La conversion de document (un document est un fichier mis en page (ex: pdf, pcl, xps, db2...))
  • Le maquettage de document (des données brutes sont injectées dans une maquette (voir M-Designer))
  • Le prétraitement des données d'entrée (des traitements simples à condition que le format soit du XML-draw)

Liste et exemples de Webservices

POST /runstream      ex: http://127.0.0.1:8002/api/runstream

Lance l'éxécution des séquences de conversion (préalablement configurées).

Données d'entrée :

Content-Type : application/json

Enveloppe JSON :
{
  "file": "data:base64,//4gACAAIAAgACAACgANAAwA",
  "conversion": "sequence1"
}

Données de sortie :

Content-Type : application/json

Enveloppe JSON :
{
  "error": [],
  "file": "data:base64,//AAIAAgACAACgANAAwA=="
}

Types d'erreur

Il y a deux canaux qui peuvent informer d'erreurs :

  • Le code HTTP retour
  • Le champ error d'un message retour.

Configuration des traitements

Pour runstream, il faut que des "séquences de conversion" aient été configurées.

Cela passe par des interface web spécifiques.

Les traitements sont stockés sur le serveur.