What This Page Does

The API Tester lets you test your site's internal connections without needing any programming tools. Think of it as a way to "talk" to your site's engine and see how it responds. You can browse all available commands your site understands, send test requests, and view the results -- all from within your admin panel.

This is useful when you want to verify that parts of your site are working correctly, explore what data is available, or troubleshoot issues with your site's features.

[Screenshot: api-tester-main-interface]

How to Get Here

Navigate to Admin Panel > Template Management > API Tester

Understanding the Page

When you open the API Tester, you see three main panels side by side, along with a statistics bar at the top and a toolbar at the bottom.

Statistics Bar

At the top of the page, five cards show you a quick summary:

Documentation Toolbar

Below the statistics bar, a row of buttons gives you quick access to documentation features:

Left Panel: Endpoint Browser

This panel lists all the commands your site understands, organized into groups (like Videos, Authentication, Users, and so on). You can expand each group to see the specific commands inside it.

Center Panel: Request Builder

This is where you set up your test. You choose what type of request to send, type in the address, and optionally add extra information before clicking Send.

Right Panel: Response Viewer

After you send a test request, the response from your site appears here. You can see the data that came back, how long it took, and whether the request was successful.

[Screenshot: api-tester-main-interface]

Common Tasks

How to Test a Basic Request

This is the simplest thing you can do -- ask your site for some data and see what comes back.

1. Look at the Endpoint Browser on the left side of the page.
2. Click a group name (for example, Videos) to expand it.
3. Click on one of the green GET commands in the list.
4. Notice that the address and method are filled in automatically in the center panel.
5. Click the green Send button.
6. View the results in the right panel.

[Screenshot: api-tester-send-request]

How to Send a Request with Data

Some commands need you to send information along with the request -- for example, logging in requires a username and password.

1. Click on a POST command from the Endpoint Browser (for example, one from the Authentication group).
2. Click the Body tab in the center panel.
3. In the text editor that appears, type the information in the required format. For example:

{
       "email": "your@email.com",
       "password": "yourpassword"
   }

1. Click the green Send button.
2. Check the response on the right side.

How to Add Search Filters to a Request

You can add filters (called parameters) to narrow down results. For example, you might want to see only the first 10 videos on page 1.

1. Set up your request by selecting a command from the Endpoint Browser.
2. Click the Params tab in the center panel.
3. Click Add Parameter.
4. Type a filter name in the Key field (for example, page).
5. Type a value in the Value field (for example, 1).
6. Add more filters if needed (for example, Key: limit, Value: 10).
7. Click Send. The filters are automatically added to your request.

How to Save a Request for Later

If you find yourself running the same test frequently, save it so you can load it with one click.

1. Set up your request (choose the command, add any data or filters).
2. Click the Save Request button below the center panel.
3. Type a descriptive name (for example, "Get All Active Videos").
4. Optionally add a description explaining what this test does.
5. Optionally type a folder name to keep your saved requests organized (for example, "Video Tests").
6. Click Save.

How to Load a Saved Request

1. Look at the bottom of the page for the Collections dropdown.
2. Click the dropdown to see your saved requests, organized by folder.
3. Select the request you want to load.
4. The command, address, and all settings are filled in automatically.
5. Click Send to run it, or make changes first.

How to Review Past Tests

Every time you send a test request, it is automatically saved to your history.

1. Look at the bottom of the page for the History dropdown.
2. Click the dropdown to see your recent tests, showing the command type, address, result status, and time.
3. Select any past test to reload it into the center panel.
4. Click Send to run it again, or adjust it before sending.

How to Clear Your History

1. Click the trash icon button next to the History dropdown at the bottom of the page.
2. A confirmation message appears asking if you are sure.
3. Click OK to delete all your history.

How to Scan and View Documentation

You can have the system automatically read your site's code and create a reference list of all available commands.

1. Click Scan Controllers in the toolbar below the statistics bar.
2. Wait a few seconds for the scan to complete. The page refreshes automatically.
3. Click View Documentation to open a window showing all discovered commands.
4. Browse the list to see what each command does, what information it needs, and whether it requires you to be logged in.
5. Click the Try button next to any command to load it directly into the center panel and test it.

How to Export Documentation

1. Click Export Markdown to get a readable text version, or Export JSON to get a data version.
2. A preview window opens showing the content.
3. Click Download to save the file to your computer.

How to Use the Built-In Help Guide

1. Click the User Guide button in the toolbar.
2. A window opens with a detailed guide explaining how APIs work, what the different request types mean, and how to read responses.
3. Use the table of contents on the left side of the window to jump to specific topics.
4. Click Print Guide at the bottom if you want a printed copy.

Understanding Request Types

When browsing commands in the left panel, you will see color-coded labels. Here is what they mean:

Understanding Responses

After you send a request, the right panel shows you the result. Here is how to read it:

Status Indicator

A colored badge at the top of the response panel tells you whether the request was successful:

Response Details

• Time shows how long the request took (in milliseconds)
• Size shows how much data came back
• The Body tab shows the actual data returned
• The Headers tab shows technical information about the response
• The Raw tab shows the unformatted response text

Request Tabs Explained

The center panel has three tabs for configuring your request:

Settings and Options

Clear Button

Click Clear below the center panel to reset everything back to the starting state. This clears the address, resets the method to GET, and empties any data you entered.

Demo Mode

If your site is running in demo mode, you will see an orange banner at the top of the page. In demo mode, you can still send test requests and browse commands, but you cannot save requests, delete collections, or clear history.

Tips for New Users

Troubleshooting

A request fails and shows an error

What you see: A red error message appears, or the response shows a status code in the 400s or 500s.

How to fix it:

1. Double-check that you selected the correct command from the Endpoint Browser.
2. If the command requires data in the Body tab, make sure it is formatted correctly with proper brackets and quotes.
3. Try refreshing the page and sending the request again.
4. If the problem continues, contact your developer or support team.

The response says "Unauthorized" (status 401)

What you see: The response shows a 401 status code or a message about being unauthorized.

How to fix it:

1. Refresh the page to renew your login session.
2. Try sending the request again.
3. Some commands require a special access token. Check the documentation for that command by clicking View Documentation in the toolbar.

The text editor area appears blank

What you see: The area where you type request data or view responses appears empty or does not load.

How to fix it:

1. Refresh the page.
2. If you use an ad blocker, try disabling it for the admin panel.
3. Try a different web browser.

Saved requests are not saving

What you see: You try to save a request but get an error message.

How to fix it:

1. Check if the orange demo mode banner is showing at the top of the page. Saving is disabled in demo mode.
2. Refresh the page and try again.
3. If the problem continues, contact your developer or support team.

History is not showing past tests

What you see: The History dropdown is empty even though you have sent requests.

How to fix it:

1. Refresh the page.
2. Send a new test request and check if it appears in the History dropdown.
3. If it still does not appear, contact your developer or support team.

Related Pages