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.

The following pages contain additional information that may be helpful with the development of Bizweaver workflows.

• Global Connections
• Using Variables

• API – Application Programming Interface. Technical tools to allow one application to interact with another, typically via “internet-type” methods.
• REST - “REST” stands for REpresentational State Transfer. A RESTful API is an application program interface (API) that uses HTTP requests to GET, PUT, POST, and DELETE data. REST technology is generally preferred to the more robust Simple Object Access Protocol (SOAP) technology because REST leverages less bandwidth, making it more suitable for internet usage. SOAP APIs are not supported in Bizweaver.

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.

1. The web service tool currently has three ways to work with known REST connections.
2. The Select Service drop-down currently has three options: Custom, Salesforce.com, and SAP Service Layer.
   1. Custom is used for all cases other than Salesforce.com and Service Layer.
   2. The Salesforce.com option provides a predefined tool specifically for working with Salesforce.com. See Salesforce API for more information on this tool.
   3. SAP Business One Service Layer is a new generation of extension API for consuming SAP Business One data and services. Working with SAP Business One Service Layer
   4. Additional predefined tools may be added in the future.
3. 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.
4. When the connection does not fit any of the above scenarios, leave the service as Custom and the “Authentication Required” checkbox blank.
   1. This will be the case for Bizweaver Web Service.

There are two main tabs associated with the actual web service call: Request Settings and Response.

The values on the Request Settings tab are used to initiate communication with the API. The values and structures used will vary by API.

1. The Construct URI text area is where the basic web service call is defined.
   1. Sample URIs and variables for web services commonly used with Bizweaver are provided in the Specific APIs section that follows below.
   2. 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 Service Layer web services.

https://YourServer:50000/b1s/v1

Instead of entering this string for each web service call, we can optionally define the string as a variable.

Then, we can reference the variable followed by the specific function we need to use in the web service tool. In the following image, we are calling the Login function.

1. Each web service must indicate the Method to be used. Select the appropriate method from the drop-down list.

1. Content-Type is used to indicate the media type of the resource. Common content types in the Bizweaver environment include “application/XML” and “application/JSON.”
2. The Advanced Settings area contains three tabs: Body Information, Header Information, and Cookies. As always, refer to the API documentation for information about what you need to send in the request and where it needs to be placed.
3. The Body Information tab offers two additional options: Raw and Form-Data.
4. The Raw option allows “free form” entry of whatever information is needed, as illustrated below.

1. Form-Data allows the use of external/non-ASCII files or large binary data sets that contains the needed information to process webservice calls. This can be helpful when you have multiple web service calls that use the same information.
2. x-www-form-urlencoded: Allows for simple text/ASCII data input

1. The Header Information and Cookies tabs are free-form text and are used as needed by the API.
2. There are three remaining options in the Request Information tab.

1. 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.
2. Format Variables for JSON is used when Bizweaver variables are used in the web service call. Selecting this option ensures that the data passed through the call are formatted correctly. This only applies if the Content-type is JSON.
   1. The Timeout value is used as a built-in “pause” mechanism. It causes this step to wait for a response from the called web service. The timeout value is only applied if a response is not received within the set time.
   2. 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.

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.

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.

1. Radio button to select the multipart/form-data API choice
2. Key field to enter the name of the variable you are passing into the API
3. 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
4. Value field this will allow you to either enter a file path or text
   1. 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.
   2. If text is selected it will allow multi-line text that will be sent through the API
5. Description allows you to enter a description of the field
6. “X” will delete the row from the grid

There are five tabs on the Response page: Content, Headers, Cookies, Details, and Log.

1. Content displays the full content of the response.
2. Headers displays information returned in the header of the response.
3. Cookies displays any cookies that are included in the response.
   1. Not all APIs will return cookies.
   2. If the target application uses cookies for authentication in subsequent requests, the response cookies can be referenced using Bizweaver step variables.
4. Details displays detailed information returned from the call.
5. Log displays the information that was sent in the call.

Images are not provided for these tabs since the information will be different for each API and the call being made.

In all steps in this document, you should always refer to the API documentation for the information you need.

• Bizweaver API
• Salesforce.com
• SAP Business One using Service Layer with Bizweaver v2.4
• SAP Business One using Service Layer with Bizweaver v2.5
• SAP Business One using Service Layer with Bizweaver v2.6 and higher
• BigCommerce API