Skip to main content

Getting Started

Get up and running with Quetzly in just a few minutes. This guide will walk you through taking your first steps with the application.

Installation​

Follow the steps in the Installation Instructions to download and install Quetzly on your system.

First Launch​

When you first launch Quetzly, you'll see the main interface with four primary sections:

  1. API - For testing API endpoints
  2. History - View your request history
  3. Sets - Manage saved requests
  4. Monitor - Set up endpoint monitoring

Interface Overview​

The left sidebar contains four main sections:

  • API API: Main testing interface
  • History History: Request history
  • Sets Sets: Saved grouping of requests
  • Monitor Monitor: Endpoint monitoring

Main Panel​

The main area adapts based on your current section:

  • Request Builder: Configure and send API requests
  • Response Viewer: Inspect API responses
  • Map Viewer: Visualize geospatial data
  • Monitoring Dashboard: Track endpoint status

Quick Start Tutorial​

1. Make Your First Request​

  1. Click on the API section in the sidebar
  2. Select a request type (GET, POST, etc.)
  3. Choose a service type (JSON, WMS, WFS, etc.)
  4. Enter a URL in the request field
  5. Click Send to execute the request

Request Bar

2. View the Response​

  • Check the Status, Time, and Size in the response section
  • Switch between Body, Headers, and Layers tabs
  • For map services, layers will be automatically detected

Request Bar

3. Add to Map (For Geospatial Services)​

  • If your request returns spatial data, you'll see available layers
  • Select layers to add them to the map viewer
  • Use the map controls to pan, zoom, and inspect features

Request Bar

4. Save Your Work​

  • Use the Sets section to save frequently used requests
  • Create collections of related API endpoints
  • Export your sets to share with team members

Request Bar

What's Next?​

Now that you have Quetzly installed and running:

Troubleshooting​

Common Issues​

Application won't start:

  • Ensure you meet the minimum system requirements
  • Try running as administrator (Windows) or with sudo (Linux)
  • Check that your antivirus isn't blocking the application

Can't connect to APIs:

  • Verify your internet connection
  • Check if the API endpoint is accessible from your network
  • Ensure firewall isn't blocking outbound connections

Map not loading:

  • Check your internet connection for basemap tiles
  • Verify the spatial data format is supported
  • Try refreshing the map view

Response is Invalid:

  • Check that you are using the right service type ie. don't try to use map service type for and expected json reponse
  • Ensure that the endpoint you are trying to test is actually able to return the expected response.

Getting Help​

If you're experiencing issues:

  1. Check our documentation
  2. Review common troubleshooting steps above
  3. Report bugs or request features on our GitHub repository

Ready to start testing? Head over to the Send Requests guide to learn about Quetzly's powerful API testing features.