Wiki

Scale Your Enterprise

User Tools

Site Tools

Trace: • Introduction (Encryption) • Supported Browser Platforms • Introduction (Test Run Tool) • Workflow Tools • Control Types • Introduction (Email) • Setup • Introduction (Looping Tool) • BigCommerce WebService Access • Setup
bw:web_service_tool

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
bw:web_service_tool [2019/03/08 09:23]
runger [Before You Begin] 		bw:web_service_tool [2022/08/02 16:25] (current)
akoehler
Line 2: Line 2:
  
 The Web Services tool is used to allow Bizweaver to interact with APIs from other applications. Bizweaver also has its own API in the form of the Bizweaver web service. Unfortunately, almost all APIs are different. This document describes how the Web Service tool is configured and provides some basic examples of how it is used for some major applications. The Web Services tool is used to allow Bizweaver to interact with APIs from other applications. Bizweaver also has its own API in the form of the Bizweaver web service. Unfortunately, almost all APIs are different. This document describes how the Web Service tool is configured and provides some basic examples of how it is used for some major applications.
- 
-====== Audience ====== 
- 
-This document is intended for developers of Bizweaver workflows. 
  
 ====== Related Documents ====== ====== Related Documents ======
  
-The following documents contain additional information that may be helpful with the development of Bizweaver workflows.+The following pages contain additional information that may be helpful with the development of Bizweaver workflows.
  
-  * [[bw:application_introduction|Application Introduction]] +  * **[[bw:global_connections|Global Connections]]** 
-  * [[bw:global_connections|Global Connections]] +  * **[[bw:using_variables|Using Variables]]**
-  * [[bw:using_variables|Using Variables]]+
  
 ====== Special Terminology ====== ====== Special Terminology ======
  
-<WRAP center round info 100%>+<WRAP center round tip 100%>
 Beginning in Bizweaver v2.0.170, two Web Service tools are displayed: WebService and WebService2. WebService2 provides a much more flexible way of working with web services including the use of REST Global Connections While workflows created using WebService will continue to function, any new workflows should use WebService 2. All references to “WebService” in this section refer to WebService2. Beginning in Bizweaver v2.0.170, two Web Service tools are displayed: WebService and WebService2. WebService2 provides a much more flexible way of working with web services including the use of REST Global Connections While workflows created using WebService will continue to function, any new workflows should use WebService 2. All references to “WebService” in this section refer to WebService2.
 </WRAP> </WRAP>
Line 33: Line 28:
   - The **Select Service** drop-down currently has two options: Custom and Salesforce.com.   - The **Select Service** drop-down currently has two options: Custom and Salesforce.com.
     - Custom is used for all cases other than Salesforce.com     - Custom is used for all cases other than Salesforce.com
-    - The Salesforce.com option provides a predefined tool specifically for working with Salesforce.com. See [[bw:salesforce_api|Salesforce API]] for more information on this tool.+    - The Salesforce.com option provides a predefined tool specifically for working with Salesforce.com. See **//[[bw:salesforce_api|Salesforce API]]//** for more information on this tool.
     - Additional predefined tools may be added in the future.     - Additional predefined tools may be added in the future.
   - When basic or oAuth 2 authentication is used, a REST Global Connection can be defined. This allows the use of the same information to be used for each call to the target system. In these cases, select the **Custom** as the Service, check the “Authentication Required” checkbox, and select the (previously defined) Global Connection from the “Select Service” drop-down.   - When basic or oAuth 2 authentication is used, a REST Global Connection can be defined. This allows the use of the same information to be used for each call to the target system. In these cases, select the **Custom** as the Service, check the “Authentication Required” checkbox, and select the (previously defined) Global Connection from the “Select Service” drop-down.
Line 39: Line 34:
     - This will be the case for Bizweaver Web Service.     - This will be the case for Bizweaver Web Service.
  
-{{:bw:webservice1.png?400|WebService Tool}}+ 
 + 
 + 
 +{{  :bw:webservice1.png?400  |WebService Tool}} 
 + 
  
 There are two main tabs associated with the actual web service call: **Request Settings** and **Response**. There are two main tabs associated with the actual web service call: **Request Settings** and **Response**.
Line 48: Line 48:
  
   - The Construct URI text area is where the basic web service call is defined.   - The Construct URI text area is where the basic web service call is defined.
-    - Sample URIs and variables for web services commonly used with Bizweaver are provided in the [[bw:web_service_tool#specific_apis|Specific APIs]] section that follows below.+    - Sample URIs and variables for web services commonly used with Bizweaver are provided in the **//[[bw:web_service_tool#specific_apis|Specific APIs]]//** section that follows below.
     - The basic URI string can also be defined as a variable and then referenced using the <F4> option and adding additional qualifiers as needed.     - The basic URI string can also be defined as a variable and then referenced using the <F4> option and adding additional qualifiers as needed.
  
Line 57: Line 57:
 Instead of entering this string for each web service call we can optionally define the string as a variable. Instead of entering this string for each web service call we can optionally define the string as a variable.
  
-{{:bw:webservice2.png?600|WebService Variable}}+ 
 + 
 +{{  :bw:webservice2.png?600  |WebService Variable}}
  
 Then, in the web service tool, we can reference the variable followed by the specific function we need to use. In the following image we are calling the Login function. Then, in the web service tool, we can reference the variable followed by the specific function we need to use. In the following image we are calling the Login function.
  
-{{:bw:webservice3.png?600|WebService Variable Usage}}+{{  :bw:webservice3.png?600  |WebService Variable Usage}}
  
   - Each web service all must indicate the **Method** to be used. Select the appropriate method from the drop-down list.   - Each web service all must indicate the **Method** to be used. Select the appropriate method from the drop-down list.
  
-{{:bw:webservice4.png?200|WebService Methods}}+{{  :bw:webservice4.png?200  |WebService Methods}}
  
   - **Content** is used to indicate the media type of the resource. Common content types in the Bizweaver environment include “application/XML” and “application/JSON.”   - **Content** is used to indicate the media type of the resource. Common content types in the Bizweaver environment include “application/XML” and “application/JSON.”
Line 73: Line 75:
  
  
-{{:bw:webservice5.png?600|WebService Advanced}}+{{  :bw:webservice5.png?600  |WebService Advanced}}
  
   - The Form-Data option allows the use of an external file that contains the needed information. This can be helpful when you have multiple web service calls that use the same information.   - The Form-Data option allows the use of an external file that contains the needed information. This can be helpful when you have multiple web service calls that use the same information.
  
-{{:bw:webservice6.png?600|WebService FormData}}+{{  :bw:webservice6.png?600  |WebService FormData}}
  
   - The Header Information and Cookies tabs are free-form text and are used as needed by the API.   - The Header Information and Cookies tabs are free-form text and are used as needed by the API.
   - There are three remaining options on in the Request Information tab.   - There are three remaining options on in the Request Information tab.
  
-{{:bw:webservice7.png?700|WebService Other Options}}+{{  :bw:webservice7.png?700  |WebService Other Options}}
  
   - **Ignore self signed certificate errors** allows communication with sites that use self-signed SSL certificates. If the response to your request indicates a certificate error, try selecting this option.   - **Ignore self signed certificate errors** allows communication with sites that use self-signed SSL certificates. If the response to your request indicates a certificate error, try selecting this option.
Line 89: Line 91:
     - Use the **File/Binary Data – Destination** option when the expected response is a file containing binary data. This option defines where the response file should be placed.     - Use the **File/Binary Data – Destination** option when the expected response is a file containing binary data. This option defines where the response file should be placed.
  
-<WRAP center round info 60%>+<WRAP center round info 80%>
 **Examples** **Examples**
   * If the called web service responds in two seconds, the workflow moves to the next step.   * If the called web service responds in two seconds, the workflow moves to the next step.
   * If the called web service does not respond within the set number of seconds, the workflow will continue to the next step.  However, this may cause other issues if the subsequent steps rely on the web service call having completed.   * If the called web service does not respond within the set number of seconds, the workflow will continue to the next step.  However, this may cause other issues if the subsequent steps rely on the web service call having completed.
 </WRAP> </WRAP>
-<WRAP center round tip 60%>+<WRAP center round info 80%>
 If you have multiple web service call that can execute concurrently (at the same time), set the timeout value to 1. If you have multiple web service call that can execute concurrently (at the same time), set the timeout value to 1.
 </WRAP> </WRAP>
Line 118: Line 120:
 ====== Specific APIs ====== ====== Specific APIs ======
  
 +  * [[Bizweaver_API|Bizweaver API]]
   * [[Salesforce_API|Salesforce.com]]   * [[Salesforce_API|Salesforce.com]]
-  * [[SBO_HANA_SL|SAP Business One on HANA using Service Layer]]+  * [[SBO_SL_v24|SAP Business One using Service Layer with Bizweaver v2.4]] 
 +  * [[SBO_SL_v25|SAP Business One using Service Layer with Bizweaver v2.5 and higher]] 
 +  * [[BigCommerce_API|BigCommerce API]] 
 + 
 +====Web Service Tool Variables=== 
 + 
 +^ Name           ^ Description^| 
 +|Alt-svc| HTTP header allows a server to indicate that another network location (the "alternative service") can be treated as authoritative for that origin when making future requests.| 
 +|AuthenticationRequired |True or False if the authentication required checkbox is selected| 
 +|BinaryDataFileName| This indicates the file name and location used for binary data and the exetension| 
 +|BodyInfo| This is the request body of the API call that is being sent if any| 
 +|BodyType| The type of body radio button that is selected ex. Raw,form-data etc.| 
 +|CF-Cache-Status| cache type being used for the API call default is Dynamic| 
 +|CF-Ray| This header is a hashed value that encodes information about the data center and the visitor’s request.| 
 +|Connection| This indicates that the WebService2 tool will keep the connection alive "keep-alive"| 
 +|Content-Encoding|The Content-Encoding representation header lists any encodings that have been applied to the representation (message payload), and in what order. This lets the recipient know how to decode the representation in order to obtain the original payload format. Content encoding is mainly used to compress the message data without losing information about the origin media type.| 
 +|Content-Length| The Content-Length header indicates the size of the message body, in bytes, sent to the recipient.| 
 +|Content-Security-Policy| The HTTP Content-Security-Policy response header allows website administrators to control the resources the user agent is allowed to load for a given page. With a few exceptions, policies mostly involve specifying server origins and script endpoints. This helps guard against cross-site scripting attacks (Cross-site_scripting).| 
 +|Content-Type| The Content-Type representation header is used to indicate the original media type of the resource (prior to any content encoding applied for sending). This will include the charset| 
 +|ContentType |The Content-Type representation header is used to indicate the original media type of the resource (prior to any content encoding applied for sending).| 
 +|CookieInfo| This will indicate if any information was entered in the cookies field if | 
 +|Date| This indicates the date and time the request is being made| 
 +|EnableJSONBodyFormat| True or False if the format body for JSON checkbox is selected| 
 +|Expect-CT| The Expect-CT header lets sites opt into reporting and/or enforcement of Certificate Transparency requirements, to prevent the use of misissued certificates for that site from going unnoticed.| 
 +|FileAttachment| This indicates the file that is attached to the request| 
 +|FormURLEncodedInfo| This indicates the data if any in the form URL encoded fields| 
 +|GraphQL| This indicates if the GraphQL radio button was selected | 
 +|HeaderInfo| This indicates if there was any header data passed into the API call| 
 +|HTTP_X_SHOPIFY_SHOP_API_CALL_LIMIT| Returns the number number of total API calls made and the total number available| 
 +|IgnoreCertificateErrors True or False if the ignore self-signed certificate errors checkbox is selected| 
 +|InputString| This is the data that is being sent to the Salesforce API| 
 +|IsBinaryData| True or False flag | 
 +|IsSuccessful| True or False flag that indicates if the API call was successful or not| 
 +|Link| This indicates the URL that is being returned by the API | 
 +|Location| This specifies the name and location of the binary that is being used for an API Call| 
 +|Method| The type of call you are making ex. Get,Post,Put,Patch,Delete| 
 +|NEL| The HTTP NEL response header is used to configure network request logging.| 
 +|OperationType| Dealing with the SAP SL or Salesforce connector it will be the option that is selected ex. Get Token, Interact with Data| 
 +|OutputString| This is the response returned from the API| 
 +|Referrer-Policy| The Referrer-Policy HTTP header controls how much referrer information (sent with the Referer header) should be included with requests. Aside from the HTTP header, you can set this policy in HTML.| 
 +|RequestTimeout| The length of time entered into the timeout field in the Webservice2 tool default 100 seconds| 
 +|RESTConnectionName| This indicates the connection used from the connection manager| 
 +|SalesForce_AccessToken| This indicates the Salesforce access token when generated using the Salesforce connector| 
 +|SalesForce_Behavior| Shows either Production or Sandbox| 
 +|SalesForce_InstanceID| This indicates the instance id sent back from Salesforce| 
 +|SalesForce_ManageData| This indicates if the manage object and data are selected when the Salesforce connector is selected| 
 +|SalesForce_ObjetName| This indicates what object is selected when managing data in the Salesforce connector | 
 +|SalesForce_RecordID| This indicates the record Id entered in the Record Id field in the Salesforce connector| 
 +|SAPServiceLayer_RecordIDDataType| This indicates the data type of Record Id for the SAP Service Layer Record Id field| 
 +|Server| the server that is used for the Webservice2 tool which is cloudflare| 
 +|ServiceType| This will show either “Get Token”, “Interact with data” or “Manage Objects” etc. For custom, it should be blank| 
 +|Set-Cookie| The Set-Cookie HTTP response header is used to send a cookie from the server to the user agent so that the user agent can send it back to the server later. To send multiple cookies, multiple Set-Cookie headers should be sent in the same response.| 
 +|StatusCode| The status of an API call response ex. 200, 400| 
 +|StatusDescription| The message for the API status code| 
 +|Strict-Transport-Security| The HTTP Strict-Transport-Security response header (often abbreviated as HSTS) informs browsers that the site should only be accessed using HTTPS and that any future attempts to access it using HTTP should automatically be converted to HTTPS.| 
 +|Transfer-Encoding| The Transfer-Encoding header specifies the form of encoding used to safely transfer the payload body to the user.| 
 +|URI| This indicated the URI entered into the Webservice2 tool| 
 +|Vary| The Vary HTTP response header describes the parts of the request message aside from the method and URL that influenced the content of the response it occurs. Most often, this is used to create a cache key when content negotiation is in use.| 
 +|X-Content-Type-Options| The X-Content-Type-Options response HTTP header is a marker used by the server to indicate that the MIME types advertised in the Content-Type headers should be followed and not be changed. The header allows you to avoid MIME type sniffing by saying that the MIME types are deliberately configured.| 
 +|StepMessage| During a failure the reason for failure will be populated here| 
 +|StepStatus| True or False| 
 +|**Note**| Some APIs will return different variables that are specific to that API and not Bizweaver|
bw/web_service_tool.1552054992.txt.gz · Last modified: 2019/03/08 09:23 by runger

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial 4.0 International
CC Attribution-Noncommercial 4.0 International Valid HTML5 Valid CSS Driven by DokuWiki