Nikode API Documentation

🚀 Quick Start

The Nikode API provides endpoints for:

• Characters: Manage anime character data with power levels and abilities
• Users: User management with role-based permissions
• Comments: Comment system for characters
• Search: Global search across all entities

🔐 Access

All API endpoints are publicly accessible:

# Example request
curl https://api.example.com/characters

👥 User Roles

• User: Basic access to read data
• Moderator: Can create and update characters, manage comments
• Admin: Full access to all endpoints, user management

📚 API Reference

🛠️ Getting Started

1. Choose your endpoint: Browse the documentation for the endpoint you need
2. Test with our playground: Use the interactive testing tools to try endpoints
3. Integrate: Use the provided examples to integrate with your application

📊 Response Format

All API responses follow a consistent format:

{
  "success": true,
  "message": "Operation completed successfully",
  "data": {
    // Response data here
  },
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 100,
    "totalPages": 10,
    "hasNext": true,
    "hasPrev": false
  }
}

❌ Error Handling

Errors follow a consistent format:

{
  "success": false,
  "error": "ERROR_CODE",
  "message": "Human readable error message",
  "statusCode": 400
}

Common error codes:

• FORBIDDEN (403): Insufficient permissions
• NOT_FOUND (404): Resource not found
• VALIDATION_ERROR (400): Invalid request data
• CONFLICT (409): Resource already exists
• INTERNAL_ERROR (500): Server error

🔗 Base URL

https://api.nikode.ir

🆘 Support

Need help? Check out our:

• Interactive Testing Playground
• Access Control Guide
• Error Code Reference