About Service Connection
In FlowOn Logic, a service connection functions as an abstraction layer that facilitates communication with third-party or external APIs. To configure it, you provide key parameters, including the target project, a unique service connection identifier, and the necessary endpoint configurations such as base URL, authentication mechanisms (OAuth, API key, etc.), and request headers. Once the connection is established, it becomes a reusable component that can be invoked within your business process flows. This integration allows FlowOn Logic to dynamically interact with external services, enabling data exchange and API-driven actions to be executed seamlessly as part of the defined workflow, while maintaining full control over error handling and response parsing.
Service Connection General Properties
When setting up a Service Connection in FlowOn logic, certain details are pivotal for its configuration and functionality. These properties provide essential information about the connection, ensuring it operates seamlessly:
| Property | Required | Description |
|---|---|---|
| Project | Yes | The project to which the service connection belongs. |
| Name | Yes | The name for the service connection. |
| Description | No | A brief description of the service connection. |
| Type | Yes | The type of service connection (Currently only supports "REST API's"). |
Service Connection Types
In FlowOn Logic, Service Connections play a crucial role in connecting and integrating with external services. Currently, FlowOn Logic primarily supports the "REST" type of service connection. However, our aim is to expand support to various other service connection types in the future, offering even more versatility in integration capabilities.
REST Service Connection Configuration Properties
Service connections require specific configurations to ensure seamless integration with external RESTful services. Here's a breakdown of the essential configuration properties for a REST Service Connection:
| Property | Required | Description |
|---|---|---|
| URL | Yes | The endpoint URL of the service or API. |
| OpenAPI Specification | Yes | The specification detailing the API's structure. |
| Security Schemes | No | Defines how the API should be accessed securely. Each scheme has a unique name and type. |
What's Next
Now that we've laid out a foundational understanding of service connections, our next step is to explore the intricacies of the configuration section. In the upcoming section, we'll guide you through the process of configuring the REST Service Connection, ensuring seamless integrations with external services.