Fonctions communes:API : Différence entre versions

De Logilys
Aller à : navigation, rechercher
Ligne 29 : Ligne 29 :
 
</pre>'''Fichier JSON'''
 
</pre>'''Fichier JSON'''
  
UID : Numéro unique servant uniquement à identifier la requête lorsqu'il est nécessaire de déboguer une requête.<br>
+
UID : Numéro unique servant uniquement à identifier la requête lorsqu'il est nécessaire de déboguer une requête.<br>Session : Texte de 100 caractères permettant de s'identifier dans ProDon. Cette chaîne de caractères doit être unique par utilisateur.<br>DemSoftware : Fait référence à la colonne « Application » dans la grille de la fenêtre de configuration de LDE. Sert à identifier à quel logiciel se connecter. (advenant le cas où vous auriez plusieurs logiciels de Logilys)<br>DemCat : Sert à identifier l'opération à effectuer. Voir la liste ci-dessous.<br>DemAction : Sert à identifier l'opération à effectuer. Voir la liste ci-dessous.<br>DemOptions : Paramètres nécessaires pour effectuer l'opération voulue. La liste va changer selon l'opération identifiée par DemAction et DemCat.
Session : Texte de 100 caractères permettant de s'identifier dans ProDon. Cette chaîne de caractères doit être unique par utilisateur.<br>
+
 
DemSoftware : Fait référence à la colonne « Application » dans la grille de la fenêtre de configuration de LDE. Sert à identifier à quel logiciel se connecter. (advenant le cas où vous auriez plusieurs logiciels de Logilys)<br>
+
'''Envoi du JSON avec curl'''
DemCat : Sert à identifier l'opération à effectuer. Voir la liste ci-dessous.<br>
+
 
DemAction : Sert à identifier l'opération à effectuer. Voir la liste ci-dessous.<br>
+
CURLOPT_URL : URL pour accéder à votre LDE.
DemOptions : Paramètres nécessaires pour effectuer l'opération voulue. La liste va changer selon l'opération identifiée par DemAction et DemCat.<br>
+
 
 +
CURLOPT_PORT : Port SSL inscrit dans la section « Web Server » de la fenêtre de configuration de LDE.
 +
 
 +
CURLOPT_USERPWD : Username et Password inscrit dans la section « Web Server » de la fenêtre de configuration de LDE.
 +
 
 +
CURLOPT_CAINFO : Doit pointer vers votre certificat SSL.
 +
 
 +
CURLOPT_POSTFIELDS : Passer le fichier JSON. Il faut absolument documenter le filecontenttype à application/json.<br>
  
 
== Ouverture de session  ==
 
== Ouverture de session  ==

Version du 24 octobre 2017 à 15:16

API


Communications (exemple en php)

Pour utiliser l'API, les requêtes doivent passer par LDE. Les communications se font par l'intermédiaire de fichiers JSON. Voici un exemple en php servant à faire une demande à LDE afin de récupérer de l'information :

$jsonfile='{';
$jsonfile.='"UID":"1318396",';
$jsonfile.='"Session":"ifcu20j7de8q5m96r1ovpheog4",';
$jsonfile.='"DemSoftware":"PRODON",';
$jsonfile.='"DemCat":"LOGIN",';
$jsonfile.='"DemAction":"SELECT",';
$jsonfile.='"DemOptions":{"LngUID":0,"UsrEmail":"exemple@exemple.com","NomSession":""}';
$jsonfile.='}';

$ch=curl_init();
curl_setopt($ch,CURLOPT_URL,"https://192.168.0.50");
curl_setopt($ch,CURLOPT_PORT,"123");
curl_setopt($ch,CURLOPT_RETURNTRANSFER,1);
curl_setopt($ch,CURLOPT_POST,1);
curl_setopt($ch,CURLOPT_USERPWD,"username:password");
curl_setopt($ch,CURLOPT_SSL_VERIFYPEER,TRUE);
curl_setopt($ch,CURLOPT_CAINFO,"/path/to/cacert.pem");
curl_setopt($ch,CURLOPT_POSTFIELDS,array("filecontenttype"=>"application/json","file"=>$jsonfile));
curl_setopt($ch,CURLOPT_SSL_VERIFYHOST,2);
curl_setopt($ch,CURLOPT_CONNECTTIMEOUT,30);
curl_setopt($ch,CURLOPT_TIMEOUT,30);
$result=curl_exec($ch);

Fichier JSON

UID : Numéro unique servant uniquement à identifier la requête lorsqu'il est nécessaire de déboguer une requête.
Session : Texte de 100 caractères permettant de s'identifier dans ProDon. Cette chaîne de caractères doit être unique par utilisateur.
DemSoftware : Fait référence à la colonne « Application » dans la grille de la fenêtre de configuration de LDE. Sert à identifier à quel logiciel se connecter. (advenant le cas où vous auriez plusieurs logiciels de Logilys)
DemCat : Sert à identifier l'opération à effectuer. Voir la liste ci-dessous.
DemAction : Sert à identifier l'opération à effectuer. Voir la liste ci-dessous.
DemOptions : Paramètres nécessaires pour effectuer l'opération voulue. La liste va changer selon l'opération identifiée par DemAction et DemCat.

Envoi du JSON avec curl

CURLOPT_URL : URL pour accéder à votre LDE.

CURLOPT_PORT : Port SSL inscrit dans la section « Web Server » de la fenêtre de configuration de LDE.

CURLOPT_USERPWD : Username et Password inscrit dans la section « Web Server » de la fenêtre de configuration de LDE.

CURLOPT_CAINFO : Doit pointer vers votre certificat SSL.

CURLOPT_POSTFIELDS : Passer le fichier JSON. Il faut absolument documenter le filecontenttype à application/json.

Ouverture de session



Nom du document : Fonctions communes:API