Skip to main content
⚠️ This is not the latest version. View latest version (6.1)
Version: 6.0

Open API Service

The Open API Service connects B2Win Suite to external REST APIs using an OpenAPI (Swagger) specification. It is used by the Invoke OpenAPI and Invoke OpenAPI with Input nodes.

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.

Configure in B2Win Suite​

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.
  • Service Override Type: Controls whether users can override this configuration.
  • 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.

See Services Configuration for admin options such as field permissions and override policies, or My Services if you are configuring this as a user.

Usage​

Once configured, the service can be selected in the Invoke OpenAPI node. If an OpenAPI specification file was uploaded, the available API paths will be automatically populated in the node's Select Path dropdown.

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.