Zingalinks API

These are the Zingalinks endpoints of the Zingasuite API. They let your own
systems mint short links, render QR codes and read click analytics without going
through the console — useful for:

  • shortening links in transactional messages your app sends,
  • generating a QR per order, ticket, asset or table in a print pipeline,
  • pulling click and scan data into your own dashboard or warehouse,
  • registering the branded hosts your links are served from.

Links you create through the API are the same objects the console shows, served
from the same edge, with the same analytics.

The base URL is:

https://api-v1.zingasuite.com/papi/v1

Access

Every request needs a zk_ API key sent as a bearer token. Reads need
data:read; writes need data:write:*. See Authentication
for the whole model.

Zingalinks needs an active plan — its own, or a paid ZingaConnect plan, which
bundles it. Without one, writes return 403 app_not_subscribed:links. Custom
domains additionally need Starter or above
(403 plan_upgrade_required:links:starter).

Sections

Shared rules

The conventions that apply to every Zingasuite endpoint:

You can try these endpoints live, with your own key, in the interactive explorer
at /_solve/api.

Was this helpful?