CallRestApiAction

XML

<action section="callRest">
  <tracelog>none|log|console</tracelog>
  <request>
    <url></url>
    <method></method>
    <expectedErrors></expectedErrors>
    <header>
      <contentType></contentType>
      <basicAuthorization></basicAuthorization>
      <certAuthorization></certAuthorization>
      <encoding></encoding>
      <accept></accept>
      <add name=""></add>
      <oauth1>
        <consumerKey></consumerKey>
        <consumerSecret></consumerSecret>
        <signatureMethod>HMAC-SHA1</signatureMethod>
        <nonce></nonce>
        <realm></realm>
      </oauth1>
    </header>
    <data>ContentObject</data>
    <params>
      <param name="">ContentObject</param>
    </params>
  </request>
  <response>ResponseConfiguration</response>
</action>

Action

Action qui permet d’appeler une action en ligne HTTPS ou HTTP (WS, API Rest, téléchargement direct), avec de nombreuses options de configuration.

Le retour de l’appel va dans l’object ResponseConfiguration qualifié par la balise response.

Tracelog permet de sortir dans la console, dans le log ou nulle part la trace de l’appel et de la réponse.

Les paramètres de la requête sont les suivants :

  • url : d’appel
  • method : GET, POST, PUT, OPTIONS
  • expectedErrors : liste des codes d’erreur qui ne lancent pas une exception mais qui renvoie tout de même le contenu de la réponse (dans le cas des API qui renvoient un code d’erreur dans le cas de non existence d’un paramètre)
  • header : contenu du header et de la configuration de la sécurité
    • contentType
    • baseAuthorization : mettre le login et le mot de passe séparés par un :
    • certAuthorization : indiquer un fichier de certificat pour l’authentification
    • encoding : encoding de la requête
    • accept
    • add : ajoute un header avec comme nom @name et le contenu dans la requête
    • oauth1 : paramètre dans le cas d’une utilisation du protocole OAuth
  • data : ContentObject contenu le data envoyé directement en POST ou en PUT dans le cas d’un POST non multipart url encoding ou d’un POST de WS SOAP ou de json.
  • params : liste des paramètres d’appel en get, en post url-encoded. Le params est un ContentObject, ce qui permet d’envoyer des fichiers en multipart/form-data par exemple.
Laisser un commentaire0

Your email address will not be published. Required fields are marked *