Open API Service

The Open API Service connects B2Win Suite to external REST APIs using an OpenAPI (Swagger) specification.

Setup Steps

First, collect the following from your API provider:

Base URL: The root URL of the API.
Authentication credentials: Depending on the API, this may be a username/password, bearer token, or API key.
OpenAPI/Swagger specification file (optional): A .json or .yaml file describing the API's endpoints.

Go to Configurations > Services and open the Open API service. Create a new configuration or edit an existing one.

Name (required): A display name for this service configuration.
Description: An optional description of the service.
Base URL: The root URL of the API.
Has OpenAPI/Swagger file: When checked, you can upload a .json or .yaml specification file. This populates the available paths automatically when using the Invoke OpenAPI node.
Auth Type (required): The authentication method. Available options:
- None: No authentication required.
- Basic: Username and password sent as Basic authentication.
- Bearer: A bearer token sent in the Authorization header.
- API Key: A named API key. Configure via API keyName and API keyValue.

Click Test Connection to verify the credentials and URL, then Save to store the configuration.

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.