Step 1 — Create a FireAPI Developer Account#
To start building and publishing APIs:2.
Go to Developer Dashboard
3.
Create your first API Hub Project
Step 2 — Create Your API (API Hub Listing)#
2.
Define API name, description, category, and logo
3.
Choose pricing model (optional)
4.
Set access type (Public / Private / Subscription-based)
API Key settings (optional)
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 SupportUpload 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.
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
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#
1.
submit your API for review
3.
list it in FireAPI API Hub
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