https://embedded-workflow-builder.netlify.app/assets/js/909b8b17.555716a5.js

1"use strict";(self.webpackChunkembedded_workflow_builder_docs=self.webpackChunkembedded_workflow_builder_docs||[]).push([["3992"],{4236(e,n,t){t.r(n),t.d(n,{metadata:()=>s,default:()=>a,frontMatter:()=>d,contentTitle:()=>o,toc:()=>h,assets:()=>c});var s=JSON.parse('{"id":"connectors/soap","title":"SOAP Connector","description":"Interact with a SOAP-based API","source":"@site/docs/connectors/soap.md","sourceDirName":"connectors","slug":"/connectors/soap","permalink":"/connectors/soap","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{"title":"SOAP Connector","sidebar_label":"SOAP","description":"Interact with a SOAP-based API"},"sidebar":"docs","previous":{"title":"Snowflake","permalink":"/connectors/snowflake"},"next":{"title":"Square","permalink":"/connectors/square"}}'),i=t(74848),r=t(28453);let d={title:"SOAP Connector",sidebar_label:"SOAP",description:"Interact with a SOAP-based API"},o,c={},h=[{value:"Protocol Specification",id:"protocol-specification",level:2},{value:"Connections",id:"connections",level:2},{value:"Basic Authentication",id:"basicauth",level:3},{value:"Prerequisites",id:"prerequisites",level:4},{value:"Configure the Connection",id:"configure-the-connection",level:4},{value:"Actions",id:"actions",level:2},{value:"Describe Client",id:"describeclient",level:3},{value:"Get Authentication",id:"getwsdlauth",level:3},{value:"Get WSDL Definition",id:"getwsdlbyurl",level:3},{value:"Request",id:"sendrequest",level:3}];function l(e){let n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",img:"img",li:"li",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.img,{alt:"SOAP",src:t(26116).A+"#connector-icon",width:"32",height:"32"}),"\n",(0,i.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/SOAP",children:"SOAP"})," (Simple Object Access Protocol) is a messaging protocol specification for exchanging structured information with web services.\nThe ",(0,i.jsx)(n.strong,{children:"SOAP"})," component supports fetching WSDL definitions, describing the methods a SOAP API supports, and making requests of the API's methods."]}),"\n",(0,i.jsx)(n.h2,{id:"protocol-specification",children:"Protocol Specification"}),"\n",(0,i.jsxs)(n.p,{children:["This component implements SOAP as defined in the ",(0,i.jsx)(n.a,{href:"https://www.w3.org/TR/soap/",children:"W3C SOAP specification"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"connections",children:"Connections"}),"\n",(0,i.jsx)(n.h3,{id:"basicauth",children:"Basic Authentication"}),"\n",(0,i.jsx)(n.p,{children:"SOAP Basic Authentication uses a username and password along with a SOAP login method to authenticate API requests."}),"\n",(0,i.jsx)(n.h4,{id:"prerequisites",children:"Prerequisites"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Access to a SOAP API that supports Basic Authentication"}),"\n",(0,i.jsx)(n.li,{children:"A valid username and password for the SOAP service"}),"\n",(0,i.jsx)(n.li,{children:"Knowledge of the SOAP login method name required by the API"}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"configure-the-connection",children:"Configure the Connection"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Username"}),": Enter the username for the SOAP API"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Password"}),": Enter the password for the SOAP API"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"SOAP Login Method"}),": Enter the method name used to authenticate with the SOAP API (e.g., ",(0,i.jsx)(n.code,{children:"Login"}),")"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"WSDL Definition URL"}),": Enter the URL to retrieve the WSDL definition from (optional, e.g., ",(0,i.jsx)(n.code,{children:"https://example.com/api.svc?WSDL"}),")"]}),"\n"]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,i.jsxs)(n.table,{children:[(0,i.jsx)(n.thead,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.th,{children:"Input"}),(0,i.jsx)(n.th,{children:"Comments"}),(0,i.jsx)(n.th,{children:"Default"})]})}),(0,i.jsxs)(n.tbody,{children:[(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"Username"}),(0,i.jsx)(n.td,{children:"Username"}),(0,i.jsx)(n.td,{})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"Password"}),(0,i.jsx)(n.td,{children:"Password"}),(0,i.jsx)(n.td,{})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"SOAP Login Method"}),(0,i.jsx)(n.td,{children:"The method used to authenticate the SOAP API."}),(0,i.jsx)(n.td,{})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"WSDL Definition URL"}),(0,i.jsx)(n.td,{children:"An optional URL to retrieve a WSDL definition from"}),(0,i.jsx)(n.td,{})]})]})]}),"\n",(0,i.jsx)(n.h2,{id:"actions",children:"Actions"}),"\n",(0,i.jsx)(n.h3,{id:"describeclient",children:"Describe Client"}),"\n",(0,i.jsx)(n.p,{children:"Description of services, ports and methods as a JavaScript object"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,i.jsxs)(n.table,{children:[(0,i.jsx)(n.thead,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.th,{children:"Input"}),(0,i.jsx)(n.th,{children:"Comments"}),(0,i.jsx)(n.th,{children:"Default"})]})}),(0,i.jsxs)(n.tbody,{children:[(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"Connection"}),(0,i.jsx)(n.td,{}),(0,i.jsx)(n.td,{})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"WSDL Definition"}),(0,i.jsx)(n.td,{children:"The WSDL definition's raw XML in string format"}),(0,i.jsx)(n.td,{})]})]})]}),"\n",(0,i.jsx)(n.h3,{id:"getwsdlauth",children:"Get Authentication"}),"\n",(0,i.jsx)(n.p,{children:"Retrieve authentication data from a SOAP endpoint by calling the specified authentication method"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,i.jsxs)(n.table,{children:[(0,i.jsx)(n.thead,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.th,{children:"Input"}),(0,i.jsx)(n.th,{children:"Comments"}),(0,i.jsx)(n.th,{children:"Default"})]})}),(0,i.jsxs)(n.tbody,{children:[(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"Connection"}),(0,i.jsx)(n.td,{}),(0,i.jsx)(n.td,{})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"WSDL Definition"}),(0,i.jsx)(n.td,{children:"The WSDL definition's raw XML in string format"}),(0,i.jsx)(n.td,{})]})]})]}),"\n",(0,i.jsx)(n.h3,{id:"getwsdlbyurl",children:"Get WSDL Definition"}),"\n",(0,i.jsx)(n.p,{children:"Retrieves a WSDL Definition from a given endpoint and returns the raw X

1ML"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,i.jsxs)(n.table,{children:[(0,i.jsx)(n.thead,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.th,{children:"Input"}),(0,i.jsx)(n.th,{children:"Comments"}),(0,i.jsx)(n.th,{children:"Default"})]})}),(0,i.jsx)(n.tbody,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"WSDL URL"}),(0,i.jsx)(n.td,{children:"The URL of the WSDL"}),(0,i.jsx)(n.td,{})]})})]}),"\n",(0,i.jsx)(n.h3,{id:"sendrequest",children:"Request"}),"\n",(0,i.jsx)(n.p,{children:"Makes a request to the SOAP webservice using the specified method"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,i.jsxs)(n.table,{children:[(0,i.jsx)(n.thead,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.th,{children:"Input"}),(0,i.jsx)(n.th,{children:"Comments"}),(0,i.jsx)(n.th,{children:"Default"})]})}),(0,i.jsxs)(n.tbody,{children:[(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"Connection"}),(0,i.jsx)(n.td,{}),(0,i.jsx)(n.td,{})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"WSDL Definition"}),(0,i.jsx)(n.td,{children:"The WSDL definition's raw XML in string format"}),(0,i.jsx)(n.td,{})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"Method"}),(0,i.jsx)(n.td,{children:"Execute the SOAP web service method"}),(0,i.jsx)(n.td,{})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"SOAP URL Override"}),(0,i.jsx)(n.td,{children:"Optionally override the default web service URL defined in the WSDL"}),(0,i.jsx)(n.td,{})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"Request Headers"}),(0,i.jsx)(n.td,{children:"Blocks of XML to include in the SOAP header of the request"}),(0,i.jsx)(n.td,{})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"SOAP Parameters"}),(0,i.jsx)(n.td,{children:"Any additional parameters to pass to the web service method"}),(0,i.jsx)(n.td,{})]})]})]})]})}function a(e={}){let{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},26116(e,n,t){t.d(n,{A:()=>s});let s="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAACXBIWXMAAAsTAAALEwEAmpwYAAAHC0l

1EQVRYhZVXiW9URRh/gkqUo9duu2/n7Zv5ZrdFSgFpOYRi6y0qBkw4ixoRUBMTjAY5FI2of4EoGuIVYzzAUtsiYlBUlMMrogVNLVjEtCpCQUrBdo/PfN++2e4uLdRJZvfNezO/7zffNd9YVv/tIsuyBnv/ll1S4nO0rnEANggF3zgK/hYK4kJBQgB0BCXsc0C/4QAsdoqLRRpOCuP/tEHeQktoXSyUfkFIdSykwxjS4YQDGoWCjE7vvO80PhWU6k3XDZdn4w2kDaafSCQyREj5lFDQRaAO6IS342hq55kkEt63mPDICAU9QanWaa1z0rEvKDyglBRSfemBkLAYCXAUoBuOoIwUo5v81l9PCKVoTTwUjtD4gFBq3IVIDGbhrlsqQB/yhEfNTkNaY1AqzPH5cWhePuYVFrHa+zJHtlaS8+BYQKmq/kgMoh/b1q6j4BenVzgDERmfHURdMhIXLVmKq9c8gXMW1GAg5GKRE8ogQXNJS1nEYt7476CU49NlWikPra6+2FF6u7fzWIbwoMApVdV44KefkFo8Huf/j7Zvx8ioUiZitFEQsHGEz4+2VOeSIF9S+gfXdfPSZQ+mH0epR7OFm06q37V7DwttPXwYG7ZswePHO3j88iuvYl5hgIn6gwJnzJyFS+5/AMNXjMJC4WSRUFH2CYDnMrRQJKUSCv7yJqe8m0BpRzffNoOFdZw4gVXX34CX5eTioqVL+V17ezteMWYsjijwsWlM271nL0LJSCafRsJgdwe0nuCRoN3rZ5O7Vym7GwLkbHPmL2DQlpYW9AuBQ4YNx/JJkzEWi+Gpzk4su3I82q7EH/fv53k9PT38v+CuuzHXX5gdMTGWJeF1Fu73+4cJBQc9lvHs5EJONrZiAh49epRBX9ywAW+bdQdu2bqVx3v2foUOhHne1m3bUho4c+YMXnfTzey8nmkztUDZMxwOWTbAjecLJaOFJ9euZeBEIsHd7HTewjtxeIGP50yaWokffLgN9+3bhw8uewgL7GB/YRonhwxKuNcSAGuTKslUv9EAhZTtKrbxPYuX4Mc7duCPTU34fn0D3jj9Vhyam4eTKqdhZfU17C9Dc/LYGXP8hSjPDcdMMyh4zRIK6pw+vJ8mUHjl+ArZo2l3ZePLseKqKXj1tdfhuAkT+bm2ro41QaH5+c6deOvtM7F88mQsGV3GawkjywRJDSSJfU8Evsu2vwmpkWVjcN369fjbkSMYjfaw6snxjEB6ptbd3c02Z7NEo9jd04NHfv8d172wnjEIq08/UNBBBH5NDz96pvgdWz4BmzyvJsFnz57Fzs5OPN3Vxb3LE0hEZs+bz2agMDWETLJq2n8Ax5RX9JETkkQsoeBQNgGfLbC+sZEBDh46hIuW3oejrxzP8T5q7DgsLh2NE6dW4vGOZDIiApMrp+HJkyd5fMfsOVhz193Y2trK4/qGBo6GPgjEicA3xgQm8dww/RaMeqqkJDRk2AiOcwo16jb7hh/fevudVMidPt2VCktKPpQrps+4nc1FWIRJ2J4pjAmOUhRsNCmYPH54fgEue/gRBvtkx6ccSuZwMd04KNl3c309EyV/+GLXLtYEqVsVl/BawqBGmIRNWL1OqL+2QgCPmTCkc57CyqTU9zZv7iuRZCQp+j5xylScWlXNpIzD0fFNBDbW1jIWYRI2ySBZXORIeImKjyqqYAiU4nZobj6uXrOGF1GIsdqg7+LDaIN2TILNu/RzhDaRJLCGsWXE0wAR0LomWXopaPKSTnxYXj4uX7Uq6TyNjbxDT23nzZZe2ZZ6R2sKbDvlzMtXrkLCdsORBG9Yqj8BoMg7jNQKDySWW1iEc2sWJk+6P/7AkaPLML8owIBG0IU6zaU1tJYwqM2tqUHCDukwq18o/XzqNAxEIn4HdCt9sF0ZJwcyOaCuvoGdjeyZH7AH1ElrtKauoSGZC5r2s1ParjQV9T9U+hn5yYIEYInRQp6nhX+7uxmgrb0d6xsacVNtLdv0fJ3mkNrb2tp4LWHMXVDDhxVhe0fxU+myU6WRAHjHIxGlBbPnz8fm5l9S2XCgzcxtbm7mWsII5zMH9GfkdyzV6r2w8APVag7AXs+holRqkermLVyIK1Y/xp48kE5zaY0sLsHcogBjJYVDi5RSZRelVvqLUCgUFEp/ZTQRlCpOO6AQ+j+dHC4oVaLX6aDF7bX7OcKt9A90kxES3jVXMVKfDEfilCcokZy305xwhNI6leK0FoMKdohIxBno7WiQIeJIvSiooC3tapbw6ga+9Xhjc2WLmYuMEUzHraPU8oqKiksGKtzymrkZW7Zd4hNKrxQKfjaZj7NY2tnAPT0ZSTgcAnjGcRxzSyasftV+QRLcSksvtbWeFgR43FF6k1DwLR3l3EF/LwDqBcDTVGPatn15Fka/1/P/AJVo/yxJZrB0AAAAAElFTkSuQmCC"},28453(e,n,t){t.d(n,{R:()=>d,x:()=>o});var s=t(96540);let i={},r=s.createContext(i);function d(e){let n=s.useContext(r);return s.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:d(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]);