Download_links

>>>

POST /api/products/:product_id/download_links
Get a time expiring secure link to a product spinner angle or set of spinner frame as an mp4/webm video.

Consult download_link response schema for resonse details and examples.

Params

Param name Description
data
optional

Resource wrapper

Validations:

  • Must be a Hash
data[type]
required

Resource type

Validations:

  • Must be one of: download_link, download_links.
data[attributes]
optional

Wrapper for entity attributes

Validations:

  • Must be a Hash
data[attributes][angle]
optional , nil allowed

Angle (lat+long), ex. H01

Validations:

  • Must be a String
data[attributes][resolution]
optional

Desired image resolution

Validations:

  • Must be a String
data[attributes][image_format]
optional

Desired image format

Validations:

  • Must be a String
data[attributes][spinner_video_id]
optional

ID of the spinner video

Validations:

  • Must be a String
data[attributes][client_ip]
required

Client IP

Validations:

  • Must be a String
data[attributes][session_id]
required

Client session ID

Validations:

  • Must be a String
data[attributes][asset_protocol]
optional

Protocol to use for asset link

Validations:

  • Must be a String
data[attributes][attachment]
optional , nil allowed

Flag indicating desire to return content-disposition as attachment

Validations:

  • Must be one of: true, false, true, false.

Headers

Header name Description
Accept
required 		application/vnd.api+json; com.pixelsquid.api.version=1
Authorization
required 		Base64 encoding of [key_id]:[secret]

For example:
Basic REVWRUxPUEVSX1BBQ0s6cGl4ZWxzcXVpZHNhbXBsZQ==

The following sample api key may be used for development purposes only:

key_id: DEVELOPER_PACK
secret: pixelsquidsample

X-Client-External-User-ID
optional 		You may pass this header to associate any api requests
with the unique identifier of the end user.