FG API

Appearance

Getting Started ​

Welcome to FG API! This guide will help you create your first custom API in just a few minutes.

What is FG API? ​

FG API is a visual platform that lets you build, configure, and deploy custom APIs without writing any code. Whether you need a simple data collection endpoint or a complex API with multiple field types, FG API makes it easy.

Quick Start ​

1. Create an Account ​

  1. Visit the FG API platform
  2. Click "Sign Up"
  3. Enter your email and password
  4. Use the approval code provided by your administrator
  5. Wait for account approval (usually instant)

2. Access the Dashboard ​

Once approved, you'll see the main dashboard with:

  • Overview of your APIs

  • Quick actions to create new endpoints

  • Analytics showing API usage

3. Create Your First API ​

  1. Click "Flow" in the sidebar

  2. Follow the 6-step process:

    • Step 1: Name your endpoint

    • Step 2: Configure fields

    • Step 3: Set validation rules (coming soon)

    • Step 4: Map responses (coming soon)

    • Step 5: Test your API (coming soon)

    • Step 6: Deploy (coming soon)

4. Test Your API ​

Once created, your API is immediately available at:

https://your-api-domain.com/api/your-endpoint-name

Key Concepts ​

Endpoints ​

An endpoint is a specific URL where your API can receive requests. Each endpoint has:

  • A unique name

  • A description

  • Associated fields

  • Configuration settings

Fields ​

Fields define what data your API accepts. Each field has:

  • Field Name: The parameter name

  • Data Type: string, number, boolean, array, or object

  • Field Type: text, single_select, multi_select, date, or object

  • Required: Whether the field is mandatory

  • Active: Whether the field is currently enabled

Flow Builder ​

The Flow Builder is our visual interface for creating APIs. It guides you through:

  1. Endpoint Setup: Name and describe your API
  2. Field Configuration: Define what data to accept
  3. Validation Rules: Set up data validation (coming soon)
  4. Response Mapping: Configure API responses (coming soon)
  5. Testing: Test your API before deployment (coming soon)
  6. Deployment: Deploy your API live (coming soon)

Next Steps ​

Need Help? ​

  • Check our API Reference

  • Contact support through the platform

  • Join our community discussions