Wiki

Scale Your Enterprise

User Tools

Site Tools

Trace: • Introduction (ExchangeConnector) • Installation Preparation • Using TWBS Credit Card Processing • Introduction (Custom Menus)
bizweaver:restapi

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
bizweaver:restapi [2025/01/13 17:34]
dtucker 		bizweaver:restapi [2025/01/14 09:52] (current)
dtucker [Using the API schema designer in BW workflow designer]
Line 25: Line 25:
   - Authentication:   - Authentication:
     - Before using any endpoints on the swagger page, click on Authorize and enter your BW API Key     - Before using any endpoints on the swagger page, click on Authorize and enter your BW API Key
 +
 +{{ :bw:bizweaverrestapi01.png?nolink&600 |}}
 +
   - Exploring Workflows:   - Exploring Workflows:
     - Open a web browser and navigate to the swagger URL https://localhost/BWAPI/swagger/index.html.     - Open a web browser and navigate to the swagger URL https://localhost/BWAPI/swagger/index.html.
Line 31: Line 34:
     - Review the list of workflows under the relevant API sections.     - Review the list of workflows under the relevant API sections.
     - Expand each endpoint to view the request and response details.     - Expand each endpoint to view the request and response details.
 +
 +{{ :bw:bizweaverrestapi02.png?nolink&600 |}}
 +
   - Testing Workflow Execution:   - Testing Workflow Execution:
     - Select the endpoint for the workflow you want to test.     - Select the endpoint for the workflow you want to test.
Line 45: Line 51:
  
 To define a payload object, click on the API icon in toolbar. To define a payload object, click on the API icon in toolbar.
 +
 +{{ :bw:bizweaverrestapi03.png?nolink&600 |}}
  
 Enter the object in Json format – Note that the object structure is what is important here (Not the values) Enter the object in Json format – Note that the object structure is what is important here (Not the values)
 +
 +{{ :bw:bizweaverrestapi04.png?nolink&600 |}}
 +
 +{{ :bw:bizweaverrestapi05.png?nolink&600 |}}
 +
 +{{ :bw:bizweaverrestapi06.png?nolink&600 |}}
  
  
  
  
bizweaver/restapi.1736807682.txt.gz · Last modified: 2025/01/13 17:34 by dtucker

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