Wiki

Scale Your Enterprise

User Tools

Site Tools

Trace: • Introduction (WebService Tool) • Salesforce.com API • about • APP - Report Maintenance and Delivery Screens • Introduction (GraphqL) • sap_business_one_integration_for_sql_server_databases • Report Data Source Types • Introduction (Migration Assistant) • Introduction (Bizweaver) • Introduction (WebService Tool v2)
bw2: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
bw2:web_service_tool [2022/08/02 16:25]
akoehler 		bw2:web_service_tool [2024/01/08 16:02] (current)
wgates [Request Settings]
Line 1: Line 1:
 ====== Introduction (WebService Tool v2)====== ====== Introduction (WebService Tool v2)======
  
-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. This document describes how the Web Service tool is configured and provides some basic examples of how it is used for some major applications.
  
 ====== Related Documents ====== ====== Related Documents ======
Line 25: Line 25:
 Before you begin to configure a web service tool, you will need information from the provider of your target API to know exactly what type of authorization will be used, what needs to be transmitted, and where (e.g., Body, Header, Cookies), and what will be returned. Before you begin to configure a web service tool, you will need information from the provider of your target API to know exactly what type of authorization will be used, what needs to be transmitted, and where (e.g., Body, Header, Cookies), and what will be returned.
  
-  - The web service tool currently has two ways to work with known **REST** connections. +  - The web service tool currently has three ways to work with known **REST** connections. 
-  - The **Select Service** drop-down currently has two options: Custom and Salesforce.com. +  - The **Select Service** drop-down currently has three options: Custom, Salesforce.com, and SAP Service Layer. 
-    - Custom is used for all cases other than Salesforce.com+    - Custom is used for all cases other than Salesforce.com and Service Layer.
     - The Salesforce.com option provides a predefined tool specifically for working with Salesforce.com. See **//[[bw2: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 **//[[bw2:salesforce_api|Salesforce API]]//** for more information on this tool.
 +    - SAP Business One Service Layer is a new generation of extension API for consuming SAP Business One data and services.  [[https://help.sap.com/doc/0d2533ad95ba4ad7a702e83570a21c32/9.3/en-US/Working_with_SAP_Business_One_Service_Layer.pdf|Working with SAP Business One Service Layer]]
     - 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 51: Line 52:
     - 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.
  
-As an example, here is the base URI to use the HANA Service Layer web services.+As an example, here is the base URI to use the Service Layer web services.
  
 https://YourServer:50000/b1s/v1 https://YourServer:50000/b1s/v1
Line 99: Line 100:
  
 Once the request information has been provided, click the __SEND__ link in the lower right corner of the screen. This will initiate a web service call to the target API based on the information provided. The screen will automatically shift to the Response tab to review the results of the call. Once the request information has been provided, click the __SEND__ link in the lower right corner of the screen. This will initiate a web service call to the target API based on the information provided. The screen will automatically shift to the Response tab to review the results of the call.
 +
 +==== Multipart\Formdata ====
 +
 +In version 2.7.8 there was new functionality added to use the content type of multipart\formdata to send files and other key-value pairs through certain APIs that use this functionality.
 +
 +{{:bw2:multipart_form_data.png|}}
 +
 +  - Radio button to select the multipart/form-data API choice
 +  - Key field to enter the name of the variable you are passing into the API 
 +  - The dropdown field that indicates if the value field is Text or a file if the file is selected the value box will have "..." that will open a file explorer to search and select files
 +  - Value field this will allow you to either enter a file path or text
 +    - If the file is selected a "..." will populate and allow you to add a file from the file explorer. A typed file path can be entered manually or a Bizweaver Variable can be added if this value changes. This file will be sent over as a binary file. 
 +    - If text is selected it will allow multi-line text that will be sent through the API
 +  - Description allows you to enter a description of the field
 +  - "X" will delete the row from the grid
 +
 +
  
 ===== Response ===== ===== Response =====
bw2/web_service_tool.1659471928.txt.gz · Last modified: 2022/08/02 16:25 by akoehler

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