Introduction

Getting started with the BugToMe API, request format, and general information.

Overview

The BugToMe API is a RESTful API that allows you to programmatically interact with BugToMe. You can create tickets, manage projects, and integrate bug tracking into your development workflow.

API Versioning

The current API version is v1. All endpoints are prefixed with /api/v1. We will maintain backward compatibility within a major version.

Request Format

All requests must be made over HTTPS. The API accepts and returns JSON data. Include the following headers in your requests: 

Content-Type: application/json
Authorization: Bearer your_api_token

Response Format

All responses are returned in JSON format. A successful response will have a 2xx status code. Error responses include a descriptive message to help you troubleshoot issues.

Success Response Example

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "title": "Login button not working",
  "status": "open",
  "created_at": "2024-01-15T10:30:00Z"
}

Error Response Example

{
  "error": "Unauthorized",
  "message": "Invalid or expired API token"
}

Rate Limiting

API requests are rate-limited to ensure fair usage. The current limits are:

  • 1000 requests per hour for authenticated requests
  • 100 requests per hour for unauthenticated requests

Rate limit information is included in the response headers: 

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1705312200

Pagination

List endpoints support pagination using page and per_page query parameters. The default page size is 25, with a maximum of 100 items per page. 

GET /api/v1/tickets?page=2&per_page=50

Pagination metadata is included in the response headers: 

X-Total-Count: 150
X-Total-Pages: 3
X-Current-Page: 2
Authentication