โ† Back to Home

Getting Started Guide

Complete guide to start using the Bobcat Backend API effectively

๐Ÿš€ Quick Start Steps

1
Explore Documentation
Visit the comprehensive API documentation to understand available endpoints, request/response formats, and authentication requirements.
๐Ÿ“š /api-docs
2
Check API Status
Verify the API health and status to ensure all services are running properly before making requests.
๐Ÿ’š /health
โ„น๏ธ /api/info
3
Authentication
Start with authentication endpoints to obtain JWT tokens required for accessing protected resources.
๐Ÿ” /api/v1/customer/auth/*
๐Ÿ” /api/v1/dealer/auth/*
4
API Usage
Include the JWT token in the Authorization header for all protected endpoints to authenticate your requests.
๐Ÿ“ Authorization: Bearer <token>

๐Ÿ” Authentication Details

๐Ÿ”‘
Token Type
JWT Bearer Token
๐Ÿ“‹
Header Format
Authorization: Bearer <token>
โฐ
Token Expiry
24 hours
๐Ÿ”„
Refresh Token
Available

โ„น๏ธ Additional Information

๐Ÿšฆ Rate Limiting
API rate limiting is implemented for security. Limits are 100 requests per minute per IP address. Response headers include X-RateLimit-* information.
โš ๏ธ Error Handling
All errors follow a standard format with status, message, and optional data fields. HTTP status codes indicate the type of error encountered.
๐Ÿงช Testing
Test the API using the built-in Swagger UI with features like "Try it out", request/response examples, and schema validation.

Ready to Get Started?