Différences entre versions de « WebAPI ACL.SSL »

De Documentation Polaris
Aller à : navigation, rechercher
(Modification automatique par le cartographe)
(Modification automatique par le cartographe)
Ligne 1 : Ligne 1 :
{{DebutInfoCartographe}}{{Jusqua|6.02}}
+
{{DebutInfoCartographe}}{{Depuis|6.02}}
  
 
L'API par Webservice vous permet de piloter ou d'interroger votre solution de gestion depuis un programme externe via un langage normalisé.
 
L'API par Webservice vous permet de piloter ou d'interroger votre solution de gestion depuis un programme externe via un langage normalisé.
 
Pour obtenir plus d'informations sur la bibliothèque d'APIs, consultez la page de documentation suivante : [[NF13075|Interface de programmation applicative par Webservice (API)]].
 
Pour obtenir plus d'informations sur la bibliothèque d'APIs, consultez la page de documentation suivante : [[NF13075|Interface de programmation applicative par Webservice (API)]].
  
<div id='api-body'><p class='prp'>L'API ACL permet de gérer la sécurité des transactions et de la session</p><h2>Methode ACL.SSL</h2><p class='appel'><span class='lbl'>Appel Web&nbsp;:</span> <span class='vlr'>http://xx.xx.xx.xx/core/api/ACL.SSL</span></p><p class='signature'><span class='return-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></span> <span class='method-name'>ACL.SSL</span><span class='parameters'>&nbsp;(<span class='opt'>[<span class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean'>Boolean</a></span> <span class='parameter-name'>onlyIfUnsecure</span> = False]</span>, <span class='opt'>[<span class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean'>Boolean</a></span> <span class='parameter-name'>onlyGetAddress</span> = False]</span>)</span></p><p class='mrp'>Provoque une redirection vers l'accès au service sécurisé si l'appelant est situé sur un accès non protégé.</p><div class='args'><p><span class='lbl'>Arguments&nbsp;:</span></p><table class='t-args'><tr><thead><th>Nom</th><th>Type</th><th>Description</th></thead></tr><tr><th class='parameter-name'>onlyIfUnsecure</th><td class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean'>Boolean</a></td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: False)<br/></span><span class='param-doc'>Indiquez vrai pour générer une redirection seulement si elle est nécessaire. Ainsi un appel sur localhost ou sur le poste en local ne vas pas générer une connexion SSL si elle est nécessaire.</span></td></tr><tr><th class='parameter-name'>onlyGetAddress</th><td class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean'>Boolean</a></td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: False)<br/></span><span class='param-doc'>Indiquez vrai pour obtenir simplement l'adresse à laquelle rediriger, et non le faire.</span></td></tr><tr class='t-return'><th>Retour</th><td class='return-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></td><td class='return-doc'>OK quand la connexion sécurisée est établie, sinon redirection, sauf si onlyGetAddress = vrai, dans ce cas, contient l'adresse de redirection</td></tr></table><p><span class='lbl'>Politique de sécurité et règles d'accès à l'API&nbsp;:</span></p><p style='padding-left:1em;'>aucune, cette API est disponible pour tous</p></div></div>
+
<div id='api-body'><p class='prp'>L'API ACL permet de gérer la sécurité des transactions et de la session</p>
 +
== Methode ACL.SSL ==
 +
<p class='appel'><span class='lbl'>Appel Web&nbsp;:</span> <span class='vlr'>http://localhost/core/api/ACL.SSL</span></p><p class='signature'><span class='return-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</span> <span class='method-name'>ACL.SSL</span><span class='parameters'>&nbsp;(<span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean Boolean]</span> <span class='parameter-name'>onlyIfUnsecure</span> = False]</span>, <span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean Boolean]</span> <span class='parameter-name'>onlyGetAddress</span> = False]</span>)</span></p><p class='mrp'>Provoque une redirection vers l'accès au service sécurisé si l'appelant est situé sur un accès non protégé.</p><div class='args'><p><span class='lbl'>Arguments&nbsp;:</span></p><table class='t-args'><tr><th>Nom</th><th>Type</th><th>Description</th></tr><tr><th class='parameter-name'>onlyIfUnsecure</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean Boolean]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: False)<br/></span><span class='param-doc'>Indiquez vrai pour générer une redirection seulement si elle est nécessaire. Ainsi un appel sur localhost ou sur le poste en local ne vas pas générer une connexion SSL si elle est nécessaire.</span></td></tr><tr><th class='parameter-name'>onlyGetAddress</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean Boolean]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: False)<br/></span><span class='param-doc'>Indiquez vrai pour obtenir simplement l'adresse à laquelle rediriger, et non le faire.</span></td></tr><tr class='t-return'><th>Retour</th><td class='return-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</td><td class='return-doc'>OK quand la connexion sécurisée est établie, sinon redirection, sauf si onlyGetAddress = vrai, dans ce cas, contient l'adresse de redirection</td></tr></table><p><span class='lbl'>Politique de sécurité et règles d'accès à l'API&nbsp;:</span></p><p style='padding-left:1em;'>aucune, cette API est disponible pour tous</p></div></div>
 
{{FinInfoCartographe}}[[Catégorie:Webservice API|ACL.SSL]]
 
{{FinInfoCartographe}}[[Catégorie:Webservice API|ACL.SSL]]

Version du 2 octobre 2017 à 12:05

Disponible depuis la version 6.02

L'API par Webservice vous permet de piloter ou d'interroger votre solution de gestion depuis un programme externe via un langage normalisé. Pour obtenir plus d'informations sur la bibliothèque d'APIs, consultez la page de documentation suivante : Interface de programmation applicative par Webservice (API).

L'API ACL permet de gérer la sécurité des transactions et de la session

Methode ACL.SSL

Appel Web : http://localhost/core/api/ACL.SSL

String ACL.SSL ([Boolean onlyIfUnsecure = False], [Boolean onlyGetAddress = False])

Provoque une redirection vers l'accès au service sécurisé si l'appelant est situé sur un accès non protégé.

Arguments :

NomTypeDescription
onlyIfUnsecureBoolean (optionnel, par défaut: False)
Indiquez vrai pour générer une redirection seulement si elle est nécessaire. Ainsi un appel sur localhost ou sur le poste en local ne vas pas générer une connexion SSL si elle est nécessaire.
onlyGetAddressBoolean (optionnel, par défaut: False)
Indiquez vrai pour obtenir simplement l'adresse à laquelle rediriger, et non le faire.
RetourStringOK quand la connexion sécurisée est établie, sinon redirection, sauf si onlyGetAddress = vrai, dans ce cas, contient l'adresse de redirection

Politique de sécurité et règles d'accès à l'API :

aucune, cette API est disponible pour tous