Skip to main content

Documentation

plain
curl -X POST https://api.gateway.io/v1/users \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "email": "user@example.com", "name": "John Doe" }' # Response { "id": "usr_1a2b3c4d", "email": "user@example.com", "name": "John Doe", "created_at": "2024-01-15T10:30:00Z" }
01

Core Concepts

API Gateway is built on three core principles: security, performance, and developer experience. Every request is authenticated and validated, rate limits protect your infrastructure, and comprehensive documentation ensures your team can integrate quickly. Our platform handles the complexity of API management so you can focus on building great products.

Frequently Asked Questions

How do I authenticate API requests?

All API requests require an API key passed in the Authorization header as a Bearer token. You can generate and manage your API keys from the dashboard. Each key can be scoped with specific permissions and rate limits for enhanced security.

What rate limits apply to my account?

Rate limits vary by plan. Free accounts get 1,000 requests per hour, Pro accounts get 10,000 requests per hour, and Enterprise accounts have custom limits. Rate limit headers are included in every response so you can track your usage in real-time.

How does OpenAPI documentation work?

API Gateway automatically generates OpenAPI 3.0 documentation from your API endpoints. The documentation is updated in real-time as you make changes and includes interactive examples, request/response schemas, and authentication details.

Can I use webhooks with API Gateway?

Yes, webhooks are supported on Pro and Enterprise plans. You can configure webhook endpoints to receive real-time notifications for events like authentication failures, rate limit violations, and custom triggers you define.

What authentication methods are supported?

API Gateway supports Bearer token authentication, OAuth 2.0, API keys, and JWT tokens. You can configure multiple authentication methods per endpoint and enforce different security policies based on your requirements.

How do I monitor API performance?

The Analytics dashboard provides real-time metrics on request volume, response times, error rates, and geographic distribution. You can set up custom alerts, export data for analysis, and integrate with monitoring tools like Datadog and New Relic.