Advanced generic API v2 resources and profiles
Understand module resources, public/restricted modes, profiles, scopes, safe columns and bounded queries.
Guides in this workflow
Follow the guide that matches the exact action, filter, menu change or issue.
Understand the advanced v2 resource API
The model/controller support module/resource definitions and public or restricted profiles.
Understand current UI availability
The supplied manage.php does not expose resource/profile forms; use only where compatible custom UI/deployment exposes them.
Save a module resource
Define module key, resource key, table, selected columns, allowed filters, maximum limit and access mode.
Understand public resources
A public resource can be read without a profile token but is subject to sensitive-column blocking and configuration.
Understand restricted resources
A restricted resource requires a valid profile token and module/resource permission.
Create a v2 integration profile
Define allowed modules/resources, IPs, rate limit, scope and one-time token.
Copy the v2 profile token once
Store it server-side; only a hash remains.
Revoke a v2 profile
Revocation blocks future restricted calls.
Send a v2 token
Use Bearer or X-Proplix-Api-Key.
Fetch resource rows
GET /api/v2/{module_key}/{resource_key}.
Fetch one resource record
Append the record ID where an id column exists.
Understand query limits
The requested limit is bounded by resource maximum and never exceeds 500.
Set offset
Offset is normalised to at least 0.
Use allowed where filters
Only configured allowed columns can be filtered.
Understand row ordering
Rows are ordered by id descending where supported.
Understand profile scope
Configured scope column/value further restricts returned rows.
Understand public sensitive-column blocking
Column fragments password, pass, token, secret, hash, key, email, phone, mobile, address, note, adminnote, private, payment, card and bank are blocked for public resources.
Understand profile resource permissions
Restricted profiles must allow both module and resource.