Open API Service
Overview
The Open API Service connects B2Win Suite to external REST APIs. It can store a base URL, optional OpenAPI/Swagger specification file, and authentication settings used by OpenAPI invoke nodes.
Purpose
Use this service when workflows need to call REST endpoints through a reusable API connection.
Setup Guide
Before configuring the service in B2Win Suite, collect the API details listed in Open API Service Setup.
Configure in B2Win Suite
Go to Configurations > Services and open Open API Service. Create a new configuration or edit an existing one.
| Field | Required | Description |
|---|---|---|
| Base URL | No | Root URL used by requests. The form placeholder is Ex. petstore.swagger.io/v2. |
| Has OpenAPI/Swagger file | No | Enables the Swagger file upload field. |
| Upload file | No | Upload an OpenAPI/Swagger file when Has OpenAPI/Swagger file is selected. |
| Auth Type | Yes | Authentication mode. Defaults to NONE. |
Authentication fields depend on Auth Type:
| Auth Type | Fields | Description |
|---|---|---|
| None | None | Sends requests without service-level authentication. |
| Basic | Username, Password | Sends username and password as Basic authentication. |
| Bearer | Token | Sends a bearer token in the authorization data used by the service. |
| API Key | API keyName, API keyValue | Sends a named API key. The service model defaults API key location to header. |
Click Test Connection to verify that the service configuration can be initialized, then Save to store it.
For administrator override settings, see Services Configuration. For user-specific settings, see My Services.
Usage
Once configured, this service can be selected in:
- Invoke OpenAPI - call an API endpoint without an upstream input.
- Invoke OpenAPI with Input - call an API endpoint after receiving upstream workflow data.
If an OpenAPI specification file is uploaded, the available paths can be loaded from the service for node configuration.
Example
Use an Open API service to call a customer status endpoint:
| Field | Example Value |
|---|---|
| Base URL | https://api.example.com |
| Has OpenAPI/Swagger file | Enabled |
| Auth Type | Bearer |
| Token | Token provided by the API provider |
After saving the service, use Invoke OpenAPI and select the customer status path from the uploaded OpenAPI file.
Troubleshooting
- Verify the Base URL is correct and reachable from the B2Win Suite server.
- Confirm the authentication credentials are valid and not expired.
- If using an API key, check that the key name and value match what the API expects.
- If paths are not appearing, verify the uploaded OpenAPI/Swagger file is valid.
Notes / Limitations
- The service form shows the fields users need for the current Open API configuration.
- Uploaded Swagger content is parsed when service methods need the available paths.