Podbul Public API

Choose your preferred documentation experience. Interactive testing, comprehensive guides, and machine-readable specifications.

Classic
🔧

Swagger UI

Traditional OpenAPI documentation interface. Familiar and reliable for developers who prefer the classic experience.

  • Try it out functionality
  • Standard OpenAPI interface
  • Built-in authentication testing
  • Downloadable specs
  • Wide tool compatibility
Open Swagger UI
Developers
📋

OpenAPI JSON

Machine-readable API specification for code generation, testing tools, and automated workflows.

  • Complete API specification
  • Code generation ready
  • Testing tool integration
  • CI/CD pipeline support
  • Standard OpenAPI 3.0 format
View OpenAPI JSON

🚀 Quick Start Guide

Get started with the Podbul Public API in just a few steps:

1. Authentication

First, authenticate using your API credentials to get your JWT token:

POST /api/v1/auth/login Content-Type: application/json { "apiKey": "your-api-key", "apiSecret": "your-api-secret" }

2. Use the Token

Include the JWT token in subsequent requests:

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

3. API Response Format

All endpoints return standardized ApiResult<T> wrapper:

{ "success": true, "data": { /* actual response data */ }, "message": "Operation completed successfully", "error": null }