API request testing and diagnostics
Use API call suggestions and parameter templates to investigate an INSIDE request, with deeper diagnostics managed by Powerfront.
What it is
API Call is a development tool for selecting an INSIDE API operation, entering parameters and viewing its response. Suggestions help you find operations and start with a parameter template. Powerfront manages deeper diagnostics, including registered-operation inspection, cached-response inspection and API error logging.
Who uses it and why
With Developer access, you can inspect request inputs and investigate an integration call. Powerfront uses restricted diagnostics when the visible response is insufficient to explain a failure.
Where to find it
Open the console icon and choose Inside Dev Console › API Call. The console is separate from Settings and is displayed for Developer access.
How it works
- Enter at least two characters in Call to request suggestions.
- Choose an operation. INSIDE fills Parameters with a JSON template based on its parameter names and types.
- Replace the template values with values appropriate for the request.
- Select Call to submit the request and view the response.
The console sends a POST request using your current operator context. The operation's own access checks still apply. A suggestion does not mean the operation is permitted for your account, nor that POST is the supported method for every operation listed.
Templates provide starting values such as empty text, false, zero or an empty object. These are placeholders, not confirmed business defaults or valid identifiers.
INSIDE also uses API metadata to describe available reports. Descriptions can include an operation's name, parameters, enum choices, required roles and result type. This metadata helps the relevant screen present choices; it is not a complete external integration specification.
Configure it
There is no separate client setting to turn on API discovery. The Developer role provides access to API discovery. Confirm the supported integration operation with Powerfront before relying on it.
Ask Powerfront to inspect registered operations or cached results when needed. Powerfront can also change API error logging. It is off by default outside development unless enabled for the installation.
Fields
| Field | Where | Required | What it is for |
|---|---|---|---|
| Call | Inside Dev Console › API Call | Yes | Selects the API operation to request. |
| Parameters | Inside Dev Console › API Call | No | Supplies the request parameters as JSON. |
Permissions
| Permission | Lets you |
|---|---|
| Developer | Displays the development console and permits API call suggestions. The requested operation still applies its own access checks. |
Limits and good to know
- Call executes the selected operation. It is not a preview and can change data when the operation performs a change.
- Parameters must contain valid JSON when populated. Check it before submitting.
- A generated parameter template does not supply required business values or verify the request.
- Discovery does not grant execution permission or confirm a supported public contract.
- Restricted cached-response inspection can expose response content. Ask Powerfront to investigate it on your behalf.
- Development logging is managed separately from the message shown to an operator. Enabling it does not necessarily expose more detail in a client response.
Depends on and works with
View all connections as a list
This feature uses
- Roles and permissionsConfigured by
Developer access controls the console, while each operation has its own permissions.
- INSIDE APIRequires
Suggestions and request execution use the registered INSIDE API operations.
- Logout and remembered computersRequires
The console uses your signed-in operator session.
Used by
- INSIDE APIEnhances
Development tools help inspect operations and investigate requests.
FAQ and troubleshooting
Why can I see an operation but not run it?
Suggestions describe registered operations. The selected operation still checks your identity, website access and required permissions when called.
Why does the generated request fail?
Replace placeholder values with valid inputs and check the JSON. Confirm that the operation supports POST and the request format you are using.
Why is the console missing?
The console is displayed for Developer access. Normal operator and Settings access does not by itself display it.
Can I inspect cached API results or turn on detailed logging?
Those diagnostics are Powerfront-managed. Ask Powerfront to investigate the affected request and adjust logging if needed.