1. Getting Started
FireAPI
  • Getting Started
    • Welcome to FireAPI.io
    • What is API Hub & App/Tool
    • Publish App/Tool
    • Publish API
  • Marketplace Overview
    • Marketplace
    • FireAPI SSO Authentication
    • Subscription Handling
    • Sample Marketplace App/Tool
    • WebGuard Frontend Documentation
    • WebGuard Backend Documentation
    • FireAPI Tool Setup Guide
  • FireAPI App/Tool - SSO Integration Examples (Common Languages)
    • All Languages
    • CURL Example (Universal)
    • JavaScript (Node.js / Express)
    • PHP Example (Native PHP)
    • Laravel Example (Recommended for PHP Developers)
    • Python Example (Flask)
    • Python Example (FastAPI)
    • Java Example (Spring Boot)
    • Go Example (Golang)
    • Best Practice (All Languages)
  1. Getting Started

Publish API

Step 1 — Create a FireAPI Developer Account#

To start building and publishing APIs:
1.
Sign up on FireAPI.io
2.
Go to Developer Dashboard
3.
Create your first API Hub Project

Step 2 — Create Your API (API Hub Listing)#

Inside the dashboard:
1.
Create a new API
2.
Define API name, description, category, and logo
3.
Choose pricing model (optional)
4.
Set access type (Public / Private / Subscription-based)
FireAPI will generate:
API ID
Client ID
Client Secret
API Key settings (optional)
Base URL configuration
Redirect URLs configuration (if SSO is enabled)

Step 3 — Add Your API Documentation & Collection#

FireAPI allows developers to publish APIs with ready-to-use documentation and testing assets.
Inside your API setup page, you can:
Upload or paste your OpenAPI / Swagger spec
Add endpoint documentation manually
Provide authentication instructions (API Key / Bearer Token / OAuth / SSO)
You can also provide a ready-to-test API collection:
✅ Postman Collection Support
Developers can:
Upload a Postman collection JSON file
Import a collection manually (paste JSON)
Add example requests & responses
Define environment variables (Base URL, API Key, Token)
This makes your API instantly usable for other developers.

Step 4 — Configure Authentication & Subscription Access#

Once your API is created, configure how users will access it:
Enable FireAPI SSO (optional)
Enable subscription-based access
Define rate limits & usage limits (optional)
Configure API key generation rules (auto-generate / manual)
Set required headers and auth format
FireAPI handles:
authentication
user identity
subscriptions
payments
API access validation

Step 5 — Test Your API Before Publishing#

Before publishing your API, you should:
1.
Test endpoints using the built-in API tester or Postman
2.
Verify authentication works correctly
3.
Confirm subscription enforcement is active
4.
Validate example responses & error formats
5.
Ensure documentation is complete

Step 6 — Publish to API Hub#

After testing your API:
1.
submit your API for review
2.
publish it
3.
list it in FireAPI API Hub
Once listed:
users can subscribe to your API through FireAPI
FireAPI handles billing and subscription validation
developers can instantly test using your Postman collection / OpenAPI docs
you focus only on improving your API endpoints and performance
Modified at 2026-03-26 16:54:25
Previous
Publish App/Tool
Next
Marketplace
Built with