Getting Started

Treblle helps you build, improve, and observe your APIs with ease. Let’s get you set up in just a few minutes.

1. Create a Treblle Account

   First, sign up for a free Treblle account. This will give you access to the Treblle dashboard, where you can observe your APIs.

2. Create Your First Project

   After logging in:

   • Go to your Treblle dashboard
   • Click “Create new project”
   • Fill in your project details:
     • Project name
     • Base URL (e.g., https://api.example.com)
     • Select your platform
     • Choose your environment (Production, Staging, Development, or Local)
     • Optionally add team members’ emails

3. Install the SDK

   Choose the SDK for your platform from our wide range of supported languages and frameworks:

   Popular SDKs

   • Laravel
   • Express
   • Spring
   • .NET Core
   • Ruby on Rails

   Can’t find your platform? Check our complete integrations list or suggest it on our Discord channel.

4. Configure Your API

   Add your Treblle credentials to your project:

   TREBLLE_API_KEY=your_sdk_token
   TREBLLE_PROJECT_ID=your_api_id

5. Enable Treblle

   Add the Treblle middleware to your API routes. The exact implementation varies by platform, but here’s a general example:

   Route::middleware(['treblle'])->group(function () {
       // Your API routes go here
   });

What’s Next?

Once integrated, Treblle automatically provides you with:

• Real-time API monitoring and logging
• Auto-generated API documentation with OpenAPI support
• API analytics
• API governance scoring
• API security
• One-click testing
• API management on the go
• Error reporting

Need Help?

• Join our Discord community
• Found a missing integration? Suggest it or contribute on GitHub

The Treblle documentation is open source, and we welcome contributions from developers like you!