Treblle Workspace
Workspaces are the central organizational unit within Treblle 3.0, allowing teams to manage APIs and collaborate efficiently. Each Workspace serves as a container for APIs, users, and settings.
Getting Started with Workspaces
Section titled “Getting Started with Workspaces”-
Sign In or Create an Account: Log in to your Treblle account.
-
Access the Workspace Dropdown: Use the Workspace dropdown at the top of the interface.
-
Choose an Option:
Join a Workspace
Section titled “Join a Workspace”If you are the Workspace Owner, invite team members to join:
Steps to Invite Members:
- Go to Workspace Settings > People.
- Enter the email addresses of team members.
- Assign roles (Owner or Member).
- Send the invitations.
Team members can accept invitations sent by the Workspace Owner.
Create a New Workspace
Section titled “Create a New Workspace”Provide a name and configure initial settings.
You can also invite members after creating the Workspace.
Here’s an example of a new Workspace:
Workspace Settings
Section titled “Workspace Settings”Workspace Owners can manage settings under the Settings tab.
Key options include:
Workspace Details: Update the name and description.
Share Feature: Toggle the share feature for all APIs in the Workspace.
Workspace Options: Leave or delete the Workspace.
Adding APIs to a Workspace
Section titled “Adding APIs to a Workspace”-
Access the Workspace Dashboard
Choose one of two options to add an API:
-
Add API Details
Select Add API and complete the required fields, such as API name and description.
-
Integrate Treblle SDK
Follow the SDK integration guide to start collecting data.
Using the Workspace Dashboard
Section titled “Using the Workspace Dashboard”Once APIs are added, the Workspace Dashboard provides high-level insights and navigation tools for managing your APIs.
API Landscape Analytics
Section titled “API Landscape Analytics”The top section displays:
- Total APIs: Number of APIs in the Workspace.
- Total Requests: Total requests across all APIs in the Workspace.
- Issues: Detected issues, updated every 5 minutes.
Navigation Tools
Section titled “Navigation Tools”- Favorites: Quickly access your most-used APIs.
- Filters: Narrow APIs by SDK or environment.
- Search: Locate APIs using free text.
- Timescale: View APIs by creation date.
Roles and Permissions
Section titled “Roles and Permissions”- Owner: Full control over Workspace and API settings.
- Member: Access is limited to assigned APIs and permissions.
More Options
Section titled “More Options”API Catalog: Publish and manage API documentation in a centralized repository, API Catalog.
Share API docs without granting direct access to API details.
Notifications: Receive in-app alerts about API comments or updates.
Support Options
Section titled “Support Options”- Documentation: Access Treblle’s guide.
- Live Support: Get responses within 5 minutes.
- Native Apps: Leverage tools like:
- Aspen- API-testing native app for macOS.
- Alfred - Treblle’s AI assistant.
- API Insights - API governance tool.