How to Create a RESTful API Using the Fuuz Platform

How to Create a RESTful API Using the Fuuz Platform

Estimated Time: Under 5 minutes
Skill Level: Beginner to Intermediate


Here’s the revised how-to article with the use of “cons” or conversational filler words removed, making it more formal and suitable for a knowledge base:

How to Create a RESTful API Using the Fuuz Platform


Estimated Time: Under 5 minutes
Skill Level: Beginner to Intermediate

Overview

This guide demonstrates how to create a RESTful API using the GraphQL API layer in Fuuz. It is based on a real-world scenario where a customer’s complex architecture was simplified significantly by leveraging Fuuz’s built-in capabilities.

Prerequisites

  • Access to a Fuuz environment
  • Admin permissions to create tenants and API keys
  • Familiarity with data models and GraphQL (optional but helpful)

Step-by-Step Instructions

1. Create a New Tenant

  • Log into your Fuuz environment.
  • Create a new tenant (e.g., Master Data Central).

2. Design a Data Model

  • Navigate to Schema Designer.
  • Create a new model (e.g., Master Product Data).
  • Add fields such as:
    • part_number (String, Required)
    • revision (String)
    • description (String)
    • on_hand_inventory (Float)
    • Optional: Add a custom JSON field for flexible data storage

3. Save and Deploy the Model

  • Save the model.
  • Add a version description (e.g., “Initial Release”).
  • Deploy the model. No migration is needed for new models.

4. Access the API

  • Open the API Explorer (GraphQL).
  • The new model (master_product_data) will appear in the documentation.
  • You can immediately:
    • Query the model
    • Use the data_change table for real-time event streaming

5. Generate an API Key

  • Go to Enterprise Admin > Administration > API Keys.
  • Create a new key:
    • Select the tenant (e.g., Fuse Overflow)
    • Assign a user with appropriate permissions
  • Copy the generated key to your clipboard.

6. Use the API

  • Use tools like Postman or Fuuz Flow Designer to:
    • Create
    • Update
    • Delete
    • Upsert data
  • The API is live and ready to use immediately after deployment.

Optional: Integrate with External Systems

Use the Data Flow Designer to:

  • Set up connections to systems like SAP, Oracle, Infor, etc.
  • Subscribe to data changes using the data_change table
  • Trigger downstream actions (e.g., update ERP, send notifications)

Key Benefits

  • No need for external infrastructure (e.g., AWS, Azure)
  • Built-in ORM and version control
  • Real-time data streaming and pub/sub support
  • Instant API generation with GraphQL
  • Full integration capabilities with enterprise systems