TechTutor

Appearance

API Testing ​

This page contains copy-paste testing examples for the current backend.

Get Sanctum Token Quickly (Local Dev) ​

Use this endpoint to mint a token for an existing user in local debug environment.

Endpoint:

  • POST /api/dev/token

Example:

bash
curl -X POST "http://127.0.0.1:8000/api/dev/token" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "student@example.com",
    "token_name": "frontend-dev-student",
    "abilities": ["*"]
  }'

If you set DEV_TOKEN_KEY in backend env, include:

bash
-H "X-Dev-Key: your-dev-key"

Response contains a token value. Use it as bearer token in requests below.

Base Variables ​

Use these in your shell before running commands.

bash
BASE_URL="http://127.0.0.1:8000/api"
TOKEN="YOUR_SANCTUM_TOKEN"

For PowerShell:

powershell
$BASE_URL = "http://127.0.0.1:8000/api"
$TOKEN = "YOUR_SANCTUM_TOKEN"

Public Endpoints ​

List courses:

bash
curl -X GET "$BASE_URL/courses"

Get one course:

bash
curl -X GET "$BASE_URL/courses/1"

Authenticated Endpoints (Sanctum) ​

Create course:

bash
curl -X POST "$BASE_URL/courses" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Laravel API Basics",
    "slug": "laravel-api-basics",
    "description": "Intro backend course",
    "price": 49.99,
    "is_published": true
  }'

Create module:

bash
curl -X POST "$BASE_URL/courses/1/modules" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Module 1",
    "slug": "module-1",
    "position": 1
  }'

Create lesson:

bash
curl -X POST "$BASE_URL/modules/1/lessons" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Lesson 1",
    "slug": "lesson-1",
    "type": "text",
    "content": "Hello TechTutor",
    "position": 1,
    "is_preview": false
  }'

Enroll in course:

bash
curl -X POST "$BASE_URL/courses/1/enrollments" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

Update lesson progress:

bash
curl -X POST "$BASE_URL/lessons/1/progress" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "progress_percent": 100
  }'

Create quiz:

bash
curl -X POST "$BASE_URL/courses/1/quizzes" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Final Quiz",
    "description": "Module checkpoint",
    "pass_score": 60,
    "is_published": true
  }'

Submit quiz attempt:

bash
curl -X POST "$BASE_URL/quizzes/1/attempts" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "answers": {
      "q1": "a"
    },
    "score": 80
  }'

Create review:

bash
curl -X POST "$BASE_URL/courses/1/reviews" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "rating": 5,
    "comment": "Great course"
  }'

Create payment:

bash
curl -X POST "$BASE_URL/courses/1/payments" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "provider": "stripe",
    "amount": 49.99,
    "currency": "USD",
    "transaction_id": "txn_1001"
  }'

Postman Testing ​

Environment Variables ​

Create a Postman environment with:

  • baseUrl = http://127.0.0.1:8000/api
  • token = your Sanctum token
  • courseId = 1
  • moduleId = 1
  • lessonId = 1
  • quizId = 1

Authorization Setup ​

At collection level:

  • Type: Bearer Token
  • Token: {{token}}

For public endpoints, set Auth to No Auth per request.

Suggested Request Order ​

  1. GET {{baseUrl}}/courses
  2. POST {{baseUrl}}/courses
  3. POST {{baseUrl}}/courses/{{courseId}}/modules
  4. POST {{baseUrl}}/modules/{{moduleId}}/lessons
  5. POST {{baseUrl}}/courses/{{courseId}}/enrollments
  6. POST {{baseUrl}}/lessons/{{lessonId}}/progress
  7. POST {{baseUrl}}/courses/{{courseId}}/quizzes
  8. POST {{baseUrl}}/quizzes/{{quizId}}/attempts
  9. POST {{baseUrl}}/courses/{{courseId}}/reviews
  10. POST {{baseUrl}}/courses/{{courseId}}/payments

Quick Troubleshooting ​

  • 401 Unauthorized: missing or invalid bearer token.
  • 403 Forbidden: role/enrollment restrictions blocked access.
  • 422 Unprocessable Entity: request body failed validation.
  • 404 Not Found: nested IDs do not belong to each other.