Verify initial installation
Follow this guide to open the page, confirm schema readiness, create a test portal profile and call session/me from a server-side test client. The guide then takes you through the correct route, the checks to complete before making changes, the workflow in order, and the evidence to review afterwards.
Where to goAdmin Area → Utilities/Tools → API Gateway
Before you start
- Verify the module is active and use the exact navigation shown above.
- Use an account with the stated module and core CRM permissions.
- Use known test records when changing statuses, visibility, saved filters or global navigation.
What you’ll accomplish
Open the page, confirm schema readiness, create a test portal profile and call session/me from a server-side test client. The instructions below follow the supplied module’s live menu, controller, form, model and JavaScript flow.
Follow these steps
- Go to Admin Area → Utilities/Tools → API Gateway.
- Find the record, endpoint, field or action used to verify initial installation.
- Complete the displayed values exactly as described in this guide.
- Select the available save, submit, send, upload, create, update or confirm action.
- Return to the related register, portal, activity log or API response and verify the expected result.
Fields and options to review
Workspace or endpointAdmin Area → Utilities/Tools → API Gateway
PurposeOpen the page, confirm schema readiness, create a test portal profile and call session/me from a server-side test client.
Rules the system enforces
- The action is available only where the supplied module exposes it and the signed-in user or API client meets the stated access conditions.
- Internal helpers are documented under the visible workflow or endpoint they support rather than presented as invented menu pages.
How to confirm it worked
- The verify initial installation workflow completes without a validation, permission, ownership or availability error.
- The related record, portal view, activity entry, notification log or API response shows the expected state.
- Client-visible, public and API data remains limited to the code-backed ownership and visibility rules.
Security, privacy and operational checks
- Use controlled test records and non-production credentials before wider rollout.
- Grant least privilege and protect secure links, personal data, uploaded files, signatures, API tokens, allowed origins and server IPs.
Continue with related guidance
Was this guide useful?Your response is stored only in this browser.