pbs-library
POST /v1/pbs-library/sessions
Start a cloud-library session for a licensed site.
Authentication
This endpoint is public. It takes no credential and no organisation — it is what our own marketing site and AI answer engines read.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/pbs-library/sessions \
-H "Content-Type: application/json" \
-d '{ "product": <string<page-builder-sandwich>>, "install_id": <string>, "license_id": <string>, "site_url": <string>, "timestamp": <integer>, "nonce": <string>, "signature": <string> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Called server-side by Page Builder Sandwich. The request is signed with the site's licensing install secret key: signature = hex(HMAC-SHA256(install_secret_key, "zinn-pbs-library/v1\n{product}\n{install_id}\n{license_id}\n{site_url}\n{timestamp}\n{nonce}")). The engine reads the install from the licensing vendor with the product's keys, recomputes the signature, and checks the licence (active, this product, a paid plan). A proof older than 5 minutes (proof_expired) or seen before (proof_replayed) is 401; a wrong signature or a lapsed licence 403 licence_refused; a free plan 403 pro_required; a vendor that cannot be reached 503 licence_unverifiable. The token is returned once and lives 30 days. Budget 30/hour per IP.
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
product | string<page-builder-sandwich> | Yes | — |
install_id | string | Yes | — |
license_id | string | Yes | — |
site_url | string | Yes | — |
timestamp | integer | Yes | Unix seconds; within 300 s of the server clock. |
nonce | string | Yes | — |
signature | string | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
token | string | Yes | zpl_…, shown once. |
expires_at | string | Yes | — |
account | PbsLibraryAccount | Yes | — |
Errors this endpoint can return
401 · 403 · 422 · 429 · 503