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

    • Related Articles

    • How to Create APIs Using Data Flows in Fuuz

      How to Create APIs Using Data Flows in Fuuz Estimated Time: 5–7 minutes Skill Level: Intermediate Overview This guide explains how to create RESTful APIs using Data Flows in Fuuz. Unlike the GraphQL-based method covered in a previous tutorial, this ...

    • How to Integrate with an HR system like ADP using Fuuz iPaaS

      In this video, our engineer walks you through the basic process of getting started with an integration to your HR / payroll provider system. In this case we are demonstrating this using the ADP Restful API interface. These concepts apply to any sort ...

    • How to create a simple Integration and Store data in Fuuz

      In this video, our engineer illustrates to other team members, how to go about calling a generic Stock Price API Get and then storing those values in Fuuz using a simple create mutation. All of this is done using our standard iPaaS capabilities which ...

    • How to use API Explorer and GraphQL to Query Data in Fuuz for Beginners

      In this video, our engineer demonstrates the No Code solution, for querying data from Fuuz. This is a proprietary and unique capability of Fuuz that no other industrial platform can provide. Typically you'd be learning how to write SQL or some other ...

    • Make REST-Based Calls With An API Key

      This article provides the resources to support the task of making REST-based calls with an API Key. Use The API Key Example HTTP Request Example PowerShell Request With Invoke-WebRequest Example PowerShell Request With Invoke-RestMethod Example cUrl ...