Sandbox Connector (BFF)

Overview

The Sandbox Connector API serves as a Backend-for-Frontend (BFF) service that allows for bulk data creation, searching, and fetching within a registry. It provides endpoints to handle various data types and operations, such as actions, resources, and seed data. This design outlines the main components, their interactions, and the data flow within the API.

Swagger Editor

Sandbox BFF Spec

Components

1. API Gateway

   • Purpose: Routes incoming requests to the appropriate backend services.

   • Responsibilities:

     • Authenticate and authorize requests.

     • Route requests to the respective endpoints in the Sandbox Connector service.

     • Aggregate responses from different services if needed.

2. Sandbox Connector Service

   • Purpose: Core service handling bulk data operations.

   • Responsibilities:

     • Manage bulk data creation, search, and retrieval.

     • Validate and process incoming data.

     • Interact with the data store to perform CRUD operations.

3. Data Store

   • Purpose: Store and manage data for the Sandbox Connector service.

   • Responsibilities:

     • Persist bulk uploaded data.

     • Store metadata and status information.

     • Support search and retrieval operations.

API Endpoints

1. Bulk Data Creation

   • POST /sandbox-connector/v1/actions/_get

     • Description: Get the action data based on user roles.

     • Request Body:

       • RequestInfo: Metadata about the request.

       • ActionDetails: Details of the actions to be created.

     • Responses:

       • 200: Successfully fetched action details.

       • 400: Invalid input.

   • POST /sandbox-connector/v1/data/_create

     • Description: Bulk upload of resource data based on type.

     • Request Body:

       • RequestInfo: Metadata about the request.

       • ResourceDetails: Details of the resources to be created.

     • Responses:

       • 200: Successfully created resource details.

       • 400: Invalid input.

   • POST /sandbox-connector/v1/seed-data/_create

     • Description: Bulk upload of seed data based on type.

     • Request Body:

       • RequestInfo: Metadata about the request.

       • EntityDetails: Details of the entities to be created.

     • Responses:

       • 200: Successfully created entity details.

       • 400: Invalid input.

• POST /sandbox-connector/v1/data/_search

  • Description: Search for API resources based on criteria.

    • Request Body:

      • RequestInfo: Metadata about the request.

      • SearchCriteria: Criteria to filter the search results.

    • Responses:

      • 200: Successfully fetched search results.

      • 400: Invalid input.

API Sequence Diagrams

Boundary Seed Data

MDMS Seed Data

Actions Get