bw2:web_service_tool
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
bw2:web_service_tool [2021/02/12 11:51] 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, | + | 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, | 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, | ||
| - | - 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 | + | - 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 |
| - The Salesforce.com option provides a predefined tool specifically for working with Salesforce.com. See **// | - The Salesforce.com option provides a predefined tool specifically for working with Salesforce.com. See **// | ||
| + | - SAP Business One Service Layer is a new generation of extension API for consuming SAP Business One data and services. | ||
| - 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:// | https:// | ||
| 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. | ||
| + | |||
| + | {{: | ||
| + | |||
| + | - Radio button to select the multipart/ | ||
| + | - 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 " | ||
| + | - Value field this will allow you to either enter a file path or text | ||
| + | - If the file is selected a " | ||
| + | - 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 | ||
| + | - " | ||
| + | |||
| + | |||
| ===== Response ===== | ===== Response ===== | ||
| Line 124: | Line 142: | ||
| * **[[bw2: | * **[[bw2: | ||
| * **[[bw2: | * **[[bw2: | ||
| + | |||
| + | |||
| + | ====Web Service Tool Variables=== | ||
| + | |||
| + | ^ Name ^ Description^| | ||
| + | |Alt-svc| HTTP header allows a server to indicate that another network location (the " | ||
| + | |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, | ||
| + | |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 " | ||
| + | |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, | ||
| + | |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, | ||
| + | |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| | ||
| + | |||
bw2/web_service_tool.1613148695.txt.gz · Last modified: 2021/02/12 11:51 by akoehler
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial 4.0 International
