ORB360 DAM DOCS
HomeLogin
  • 🚀Getting Started
  • EMBED
    • Single 360 - Hosted
    • Multiple 360 - Hosted
    • Advanced 360 - Hosted
    • 360 Player - Custom
  • API REFERENCE
    • Introduction
    • Specification
    • Authentication
  • ENDPOINTS
    • Integration
    • Integration - JOOR
    • Tenant
    • Shoot
    • Media
    • Tag
    • Image
Powered by GitBook
On this page

Was this helpful?

  1. ENDPOINTS

Image

PreviousTag

Last updated 1 year ago

Was this helpful?

Use the image endpoints to retrieve images stored against Media

Unlike other API endpoints, images may only be retrieved via the cdn.orb360.tech domain

Get an Image (from Media)

get

Retreive an image using it's path and signing parameter, specifying a particular image size, quality and format.

Path parameters
imgPathstringRequired

Path to the stored image in the DAM

Example: 7e5092af-f35b-4e61-9a90-953d06eaa056/shoots/8ee5480a-bc94-4f56-b354-ce71ad0a6458/89b05784-9dd3-4aba-8769-04fd2370246e/img10.jpg
Query parameters
fmtstringOptional

The image format (jpeg, webp or png) to convert to and return

Default: jpegExample: png
wnumberRequired

The image width (px) to resize the image to, height is scaled based on the image aspect ratio automatically

Example: 1024
qnumberOptional

The image quality to use when resampling the image 100=best,longest 1=worst,quickest

Default: 90Example: 94
sstringRequired

The signing secret provided by the server for this request. All request parameters must be provided by the server.

Example: 498c6036059d94be00931750369ef1fb3c33b965113c4560880e352be097337d
Responses
200
success
Responsefile
400
bad request
application/json
404
not found
application/json
get
GET /image/{imgPath} HTTP/1.1
Host: api.orb360.tech
Accept: */*

No content