API Testing

As a City Admin user, you can test the API for location widgets and integration widgets from the admin panel in Citizen Portal.

Location widgets

To test the API for a location widget, you need to:

1. Select the "Widgets" tab
2. Find the specific location widget you'd like to test from the list of widgets
3. From the "Actions" dropdown menu, select "Edit"
4. Then, select "Content" from the side menu

This will take you to the content panel for the location widget. Here you can set and test the API for the widget.

Run an API test for location widgets

To test the API, you need to :

1. Select the "Test API" button next to the "API endpoint" field
2. This will open the "Test API" screen and the "API endpoint to test field" will auto-populate with the current API endpoint for the widget. You can change this if you'd like.
3. Enter the address you'd like to test the API endpoint for
4. Select the "Run" button to complete the API test

The API tester will give you the following information.

Integration widgets

You can only test the API endpoints for integration widgets for existing users who have successfully linked their accounts or by manually entering a valid access token. To test the API for one of your integration widgets, you need to:

1. Select the "Widgets" tab
2. Find the specific integration widget you'd like to test from the list of widgets
3. From the "Actions" dropdown menu, select "Edit"
4. Then, select "Content" from the side menu

This will take you to the content panel for the integration widget. Here you can set and test the API for the widget.

Run an API test for integration widgets

To test the API, you need to :

1. Select the ‘Test API’ button next to the "API endpoint" field
2. This will open the "Test API" screen and the "API endpoint to test field" will auto-populate with the current API endpoint for the widget. You can change this if you'd like.
3. Select the link account associated with this widget from the "Select link account" dropdown menu
4. Choose if you want to run a manual or user based test
5. Select the "Run" button to start the test

If you select the "Manual" access token, you'll need to enter the access token manually and select the address that you want to test the API endpoint for. Please note that if the widget is not property dependent, the address fields will not appear here.

If you select the "User based" access token, you'll need to select the user and address that you want to test the API endpoint for. Please note that if the widget is not property dependent, the address fields will not appear here.

The API tester will give you the following information.