Skip to content

Postman Collection v2 - Quick Reference Card

🚀 Quick Start

  1. Import collection_v2.json + environment_local.json
  2. Select "BacMR Local (v2)" environment
  3. Run "Auth → Signin" → JWT auto-saved
  4. Run "Chat → Ask Question" → Test complete!

📌 Most Used Endpoints

Endpoint Folder Auth Purpose
POST /auth/signin 1. Auth None Get JWT (auto-saved)
GET /wallet/balance 4. Wallet User Check balance & tier
POST /chat/ask 2. Chat User Ask question (RAG)
POST /quizzes/generate 3. Quizzes User Generate quiz
POST /ingestion/jobs 5. Ingestion Admin Start ingestion
POST /admin/scraping/{source}/sync 7. Scraping Admin Run scraper
GET /metrics/json 9. Metrics None View metrics

🔑 Auto-Captured Variables

These are automatically saved from responses (no copy-paste needed):

Variable Captured From Used In
{{bacmr_jwt}} Signin All authenticated requests
{{user_id}} Signin User-specific endpoints
{{last_request_id}} All responses Debugging, correlation
{{last_job_id}} Create Ingestion Job Poll job status
{{current_balance}} Get Balance Balance tracking
{{user_tier}} Get Balance Tier verification

🧪 Quick Tests

Test Auth

Run: Auth → Signin
✓ JWT saved to {{bacmr_jwt}}

Test Chat

Run: Chat → Ask Question (French)
✓ Answer returned with sources
✓ Tokens deducted

Test Rate Limit

Run: Testing → Rate Limit Test
Use Runner: 11 iterations
✓ 11th request → 429

Test Metrics

Run: Metrics → Get Metrics (JSON)
✓ Counters, histograms, gauges displayed

⚡ Keyboard Shortcuts

Action Shortcut
Send request Cmd+Enter (Mac) / Ctrl+Enter (Windows)
Save request Cmd+S / Ctrl+S
Open console Cmd+Alt+C / Ctrl+Alt+C
Environment quick look Click eye icon 👁️

🐛 Common Issues

Issue Solution
401 Unauthorized Run "Auth → Signin" to get fresh JWT
429 Too Many Requests Wait retry_after seconds
402 Insufficient Balance Check balance, add tokens
403 Forbidden Ensure logged in as admin (for admin endpoints)

📖 Full Docs

  • Setup: README_v2.md
  • Workflows: TESTING_WORKFLOWS.md
  • Architecture: ../docs/backend_architecture.md

Happy Testing! 🎉