3a41ba99bb
- Removed hardcoded model defaults and the MODEL_CONFIG dictionary. - Updated get_model_config() to require an account parameter and raise clear errors if IntegrationSettings are not configured. - Eliminated unused helper functions: get_model(), get_max_tokens(), and get_temperature(). - Improved error handling to provide specific messages for missing account or model configurations. - Cleaned up orphan exports in __init__.py to maintain a streamlined codebase.
IGNY8 API Documentation
Version: 1.0.0
Last Updated: 2025-11-16
Complete documentation for the IGNY8 Unified API Standard v1.0.
Documentation Index
Getting Started
-
API Documentation - Complete API reference with examples
- Quick start guide
- Endpoint reference
- Code examples (Python, JavaScript, cURL)
- Response format details
-
Authentication Guide - Authentication and authorization
- JWT Bearer token authentication
- Token management
- Code examples
- Security best practices
-
Error Codes Reference - Complete error code reference
- HTTP status codes
- Field-specific errors
- Error handling best practices
- Common error scenarios
-
Rate Limiting Guide - Rate limiting and throttling
- Rate limit scopes
- Handling rate limits
- Best practices
- Code examples
Integration Guides
-
Migration Guide - Migrating to API v1.0
- What changed
- Step-by-step migration
- Code examples
- Breaking changes
-
WordPress Plugin Integration - WordPress integration
- PHP API client
- Authentication
- Error handling
- Best practices
Interactive Documentation
- Swagger UI:
https://api.igny8.com/api/docs/ - ReDoc:
https://api.igny8.com/api/redoc/ - OpenAPI Schema:
https://api.igny8.com/api/schema/
Quick Start
1. Get Access Token
curl -X POST https://api.igny8.com/api/v1/auth/login/ \
-H "Content-Type: application/json" \
-d '{"email":"user@example.com","password":"password"}'
2. Use Token
curl -X GET https://api.igny8.com/api/v1/planner/keywords/ \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json"
3. Handle Response
All responses follow unified format:
{
"success": true,
"data": {...},
"request_id": "uuid"
}
API Standard Features
- ✅ Unified Response Format - Consistent JSON structure
- ✅ Layered Authorization - Authentication → Tenant → Role → Site/Sector
- ✅ Centralized Error Handling - All errors in unified format
- ✅ Scoped Rate Limiting - Different limits per operation type
- ✅ Tenant Isolation - Account/site/sector scoping
- ✅ Request Tracking - Unique request ID for debugging
Support
- Interactive Docs: Swagger UI
- Error Reference: Error Codes
- Contact: Include
request_idfrom responses when contacting support
Last Updated: 2025-11-16
API Version: 1.0.0