Advanced generic API v1 sources and keys
Understand source definitions, one-way keys and filtered table access exposed by controller/model capabilities.
Guides in this workflow
Follow the guide that matches the exact action, filter, menu change or issue.
Understand the advanced v1 source API
The model/controller support configured table sources and one-way API keys beyond the current simplified portal UI.
Understand current UI availability
The supplied manage.php does not expose source/key forms; use these capabilities only where a compatible deployment/custom UI exposes them.
Save a source definition
Define source key, label, table, selected columns, allowed filters and maximum limit through the compatible admin route.
Complete source key
Use the configured identifier in /api/v1/{source_key}.
Complete source table
Use an approved existing table; do not expose arbitrary user input.
Complete source columns
Select only columns intended for the integration.
Complete allowed filters
Only configured filter columns are accepted.
Set maximum result limit
Bound integrations to the configured maximum.
Create an API key
Create a one-time plaintext token associated with allowed sources.
Copy the key once
Store it server-side; the database retains only its hash.
Revoke a v1 key
Revocation prevents further authentication.
Call API ping
Use the authenticated ping endpoint to verify key handling.
Fetch source rows
GET /proplix_api_gateway/api/v1/{source_key} with allowed filters/limit/offset.
Fetch one source record
Append a record ID where the configured source supports an id column.
Use GET for v1 data
Unsupported methods are rejected.
Understand key-to-source permission
A key must explicitly allow the source.