Advanced generic API v1 sources and keys
Understand source definitions, one-way keys and filtered table access exposed by controller/model capabilities.
Proplix Secure API Gateway
Open guide →GuideUnderstand the advanced v1 source API
The model/controller support configured table sources and one-way API keys beyond the current simplified portal UI.
Open guide →GuideUnderstand 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.
Open guide →GuideSave a source definition
Define source key, label, table, selected columns, allowed filters and maximum limit through the compatible admin route.
Open guide →GuideComplete source key
Use the configured identifier in /api/v1/{source_key}.
Open guide →GuideComplete source table
Use an approved existing table; do not expose arbitrary user input.
Open guide →GuideComplete source columns
Select only columns intended for the integration.
Open guide →GuideComplete allowed filters
Only configured filter columns are accepted.
Open guide →GuideSet maximum result limit
Bound integrations to the configured maximum.
Open guide →GuideCreate an API key
Create a one-time plaintext token associated with allowed sources.
Open guide →GuideCopy the key once
Store it server-side; the database retains only its hash.
Open guide →GuideRevoke a v1 key
Revocation prevents further authentication.
Open guide →GuideCall API ping
Use the authenticated ping endpoint to verify key handling.
Open guide →GuideFetch source rows
GET /proplix_api_gateway/api/v1/{source_key} with allowed filters/limit/offset.
Open guide →GuideFetch one source record
Append a record ID where the configured source supports an id column.
Open guide →GuideUse GET for v1 data
Unsupported methods are rejected.
Open guide →GuideUnderstand key-to-source permission
A key must explicitly allow the source.
Open guide →