Signed links

Create a signed link

Returns base_url and the HMAC secret once; SDKs sign URLs locally with it. Use access: "open" for tools that cannot compute an HMAC.

post/v1/signed-links

Request

  • Base URL: https://api-eu.dynamicdocumentapi.com
  • URL: https://api-eu.dynamicdocumentapi.com/v1/signed-links
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Headers

Idempotency-Keystring

Replays the stored response for 24 h; a different body with the same key → 422.

Request body

access'signed' | 'open'

open accepts unsigned requests within allowed_params and param_limits.

  • signed - signed
  • open - open
allowed_paramsstring[]

Dynamic properties callers may set, e.g. title.text.

allowed_referrersstring[]
cache_ttl_secondsinteger nullable
defaultsobject
enabledboolean
expires_atstring date-time nullable
fallback_image_asset_idstring nullable

Ready image asset (ast_…) returned instead of 402 render_limit_reached; null clears.

formatsstring[] required
namestring required
param_limitsobject
quota_totalinteger nullable
rate_limit_per_ip_per_hourinteger nullable
template_idstring required

Response

Created; secret is shown once.

access'signed' | 'open' required
  • signed - signed
  • open - open
allowed_paramsstring[] required
allowed_referrersstring[] nullable required
base_urlstring uri required

Append /{any-name}.{ext}?… and a signature.

cache_ttl_secondsinteger nullable required
created_atstring date-time required
defaultsobject required

Parameter values used when the URL omits them.

enabledboolean required
expires_atstring date-time nullable required
fallback_image_asset_idstring nullable required

ast_…: image served instead of 402 render_limit_reached.

formatsstring[] required
idstring required

lnk_…

namestring required
objectstring
param_limitsobject required

e.g. {"title.text": {"max_length": 80}}.

quota_totalinteger nullable required
quota_usedinteger required
rate_limit_per_ip_per_hourinteger nullable required
secretstring required

base64url HMAC-SHA256 key. Shown once.

template_idstring required

Changes

No recorded changes to this operation across all 2 revisions of this API.