Logging via the API
The system keeps a per-client log. It records what happened around a customer or the system, is visible in the backends, primarily read by the PCG backend. As an API user you can write your own entries — recommended for external integrations so support can trace what your integration did and when.
Endpoints
| Endpoint | Purpose |
|---|---|
/api/client/log1 |
Write a customer-related entry. It is attached to a customer record and shows up in that customer's activity log. |
/api/system/log1 |
Write a system-related entry (not bound to a customer), e.g. sync runs, device events, background jobs. |
/api/system/log1 |
Write a system-related entry (not bound to a customer), e.g. sync runs, device events, background jobs. |
/api/driver/info1 |
Message from the Driver universe, most options there read a note comment too. |
Both need an authenticated session (customer logon or API session). Explore the
live documentation with ?oo-rf=html on either endpoint.
Hints and gotchas
- Keep messages short and factual. 240 characters max; put identifiers (order id, external reference) at the front so they survive a cut.
- Always set
parto your source name. Entries without a source are hard to attribute when several integrations log into the same tenant. - Don't log secrets or personal data. Log entries are retained for weeks to months, are visible to shop staff, and are synced to the backend.
- Rate: log sparingly. One entry per business event, not per HTTP call. High-frequency logging pollutes the customer activity view.
- Certain infrastructure noise (e.g. reachability messages) is silently skipped
server-side; the call still returns
ok.
Example
POST /v3/shop/<sysname>/api/client/log1
Content-Type: application/x-www-form-urlencoded
msg=Order+12345+exported+to+ERP&par=erp-bridge&dt=2026-05-17T14:30:00
Response (?oo-rf=json):
{"logresults":[{"action":"Log","result":"ok"}]}