API Documentation

Integrate Bug Buddy into your applications with our comprehensive REST API. Test endpoints directly in your browser.

🚀Quick Start

Base URL

https://api.bugbuddy.app

JWT Token

Authorization: Bearer YOUR_TOKEN

API Key

X-API-Key: YOUR_API_KEY

Authentication

/api/auth
POST/api/auth/register

Register a new user account

POST/api/auth/login

Login and get authentication token

POST/api/auth/logout

Logout current user

POST/api/auth/forgot-password

Request password reset email

Bugs

/api/bugs
GET/api/bugs/

Get all bugs with optional filters

GET/api/bugs/1

Get bug by ID

POST/api/bugs/

Create a new bug

PUT/api/bugs/1

Update bug

DELETE/api/bugs/1

Delete bug

Projects

/api/projects
GET/api/projects/

Get all projects

GET/api/projects/1

Get project by ID

POST/api/projects/

Create new project

PUT/api/projects/1

Update project

DELETE/api/projects/1

Delete project

💻Code Examples

Create Bug (JavaScript)

// Create a bug
const response = await fetch('https://api.bugbuddy.app/api/bugs', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    title: 'Button not working',
    description: 'The submit button does not respond when clicked',
    priority: 'high',
    status: 'open',
    project_id: 1,
    category_id: 2
  })
});

const bug = await response.json();
console.log(bug);

Get Bugs with Filters

// Get all bugs with filters
const response = await fetch(
  'https://api.bugbuddy.app/api/bugs?status=open&priority=high',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const bugs = await response.json();
console.log(bugs);

External API (Public Access)

// Create bug via API key (external)
const formData = new FormData();
formData.append('title', 'Bug from external system');
formData.append('description', 'Bug description');
formData.append('priority', 'medium');
formData.append('media', file);

const response = await fetch('https://api.bugbuddy.app/api/v1/bugs', {
  method: 'POST',
  headers: {
    'X-API-Key': 'YOUR_API_KEY'
  },
  body: formData
});

const result = await response.json();
console.log(result);

📚Additional Resources

API Limits

  • • Rate Limit: 100 requests/minute per API key
  • • Response Format: All responses are JSON
  • • Pagination: Use limit and offset

Error Codes

  • • 200 - Success
  • • 201 - Created
  • • 400 - Bad Request
  • • 401 - Unauthorized
  • • 404 - Not Found
  • • 500 - Server Error

Ready to Get Started?

Start integrating Bug Buddy API into your application today. Get your API key and start tracking bugs programmatically.