Getting Started
To begin using the FAQCraft API, you'll need to understand a few key concepts:
Base URL
All API requests should be made to:
https://api.faqcraft.comAuthentication
Most endpoints require authentication using a Bearer token. Include your token in the Authorization header:
Authorization: Bearer YOUR_API_TOKENObtain your token by logging in via the authentication endpoints.
HTTP Status Codes
The API uses standard HTTP status codes to indicate the success or failure of requests:
200- Successful request400- Bad request (validation errors)401- Unauthorized (invalid or missing token)404- Resource not found500- Server error
Error Response Format
When an error occurs, the API returns a JSON object with an error message:
{
"error": "Validation error message"
}Rate Limiting
The API implements rate limiting to ensure fair usage. If you exceed the rate limit, you'll receive a 429 status code.