# 📡 Employee Engagement Platform API - Share This!

## 🌐 **Live API Access**

**🔗 API Documentation**: http://localhost:8000/api/documentation  
*Replace with your ngrok URL when sharing externally*

**📋 Base API URL**: http://localhost:8000/api/v1  
*All endpoints start with this URL*

---

## 🚀 **Quick Test (Copy & Use)**

### 1. Register a New User
```bash
curl -X POST "http://localhost:8000/api/v1/auth/register" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Test User",
    "email": "test@example.com",
    "password": "password123", 
    "password_confirmation": "password123"
  }'
```

### 2. Login & Get Token
```bash
curl -X POST "http://localhost:8000/api/v1/auth/login" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "test@example.com",
    "password": "password123"
  }'
```

### 3. Use Token for Protected Endpoints
```bash
curl -X GET "http://localhost:8000/api/v1/users" \
  -H "Authorization: Bearer YOUR_TOKEN_HERE" \
  -H "Content-Type: application/json"
```

---

## 🎯 **Available Endpoints**

| Category | Endpoint | Method | Description |
|----------|----------|--------|-------------|
| **Auth** | `/auth/register` | POST | Register new user |
| **Auth** | `/auth/login` | POST | Login user |
| **Auth** | `/auth/logout` | POST | Logout user |
| **Users** | `/users` | GET | List all users |
| **Users** | `/users/{id}` | GET | Get user details |
| **Quizzes** | `/quizzes` | GET | List quizzes |
| **Challenges** | `/challenges` | GET | List challenges |
| **Rewards** | `/rewards` | GET | List rewards |
| **Teams** | `/teams` | GET | List teams |

*See full documentation at the API Documentation URL above*

---

## 🔐 **Authentication Required**

Most endpoints require authentication:
1. Register or login to get a token
2. Include token in header: `Authorization: Bearer YOUR_TOKEN`
3. Use Swagger UI "Authorize" button for easy testing

---

## 🌍 **For External Access**

**Developer Instructions:**
1. Install ngrok: https://ngrok.com
2. Run: `ngrok http 8000`
3. Share the ngrok URL (https://abc123.ngrok.io)
4. Replace localhost URLs above with your ngrok URL

---

## 📞 **Support**
Questions? Contact the development team!