Components of the platform

5min

Components

The platform comprises three major components: API, Flow, and Upstream. Let's explore each component in more detail:

API:

  • The API is the highest-level component in the No-code API Orchestrator.
  • It represents a group of flows that are executed to achieve the desired result or output.
  • APIs encompass essential elements of the client endpoint, such as input fields, API paths, and other relevant information.

Flow:

  • The flow is an entity that consists of a group of upstreams, which are also known as vendors.
  • It establishes the relationship between upstreams within a flow. For example, a flow named "Test Flow" may have three upstreams, and the flow determines the sequence or parallel execution of these upstreams.
  • The flow governs whether upstreams are called one-after-another, parallelly, or using a combination of both strategies.
  • It manages the coordination and execution flow of the upstreams within the API.

Upstream:

  • An upstream is synonymous with a vendor and represents the vendor's endpoint.
  • It contains crucial details about the vendor's endpoint, such as the URL, HTTP method, request body, and other relevant configurations.
  • Each upstream corresponds to a specific external system or service that the API interacts with.

The platform’s three major components work together to enable seamless integration and interaction. The API defines the high-level functionality and endpoints, while the flow orchestrates the sequence and execution of upstreams. Each upstream represents a vendor and encompasses the necessary details to interact with external systems or services. By combining these components, the No-code API Orchestrator facilitates efficient integration and workflow management.

Relation between Components of API Orchestration

Document image