Advanced embeddable link / canvas usage
Note: These features require a shoot to be both published and have public integration access enabled. If you require assistance configuring your shoot please contact your ORB360 account manager.
Common URL parameter options
| Parameter | Default | Description |
|---|---|---|
| tenant | Unique identifier for the tenant | |
| endpoint | id | Integration endpoint type for lookup of 360s (tag,id) |
| q | Comma separated search values (ids or tag values) | |
| split | , | Separator used to split search values in q |
| duration | 5000 | Duration of one full spin in ms |
| playMode | once | Onload spin behaviour (once,continuous,none) |
| allowFullscreen | true | Display fullscreen controls |
| zoom | true | Toggle click to zoom capability |
| hideControls | true | Hides controls when not in focus |
| hideAudioControls | false | Hides audio mute button and volume slider |
Display many 360s across all tenant shoots
The iframe or shareable URL can be modified to look up 360 ids from any shoot within a single tenant.
The query (q) parameter in this example can be modified to include any set of media ids within the tenant, separated by a comma (,).
Due to URL length restrictions, up to 20 id values are supported via URL.
Example
https://cdn.orb360.tech/orb360embed/v1.2.5/?tenant=900f7225-ee48-40e7-b51b-39bb77191c1d&endpoint=id&q=76e8fcbf-9b62-4a4a-b353-aa04a8d66a73,f4600b75-e8b5-4cd0-b7b5-89de0e26aea3&duration=5000&zoom=true&allowFullscreen=true&playMode=once&hideControls=true&hideAudioControls=falseDisplay 360s by tag value
The iframe or shareable URL can also be modified to search for 360s by a single tag key and a set of values.
In order to do this, the URL should be modified. The endpoint parameter value should be changed to tag.
Unlike the id endpoint, the tag endpoint can return multiple values for a tag lookup.
An additional property, called key should be passed with the tag key to search on. By default this is StyleNumber.
The query (q) param can then accept comma separated tag values to search for, eg. I_AM_A_STYLE_NUMBER,DEF-456
An optional parameter called split can be added to set the separator character to be used, in case your tag values contain commas. It is your responsibility to ensure that your request tag query separator character does not collide with characters in your tag values.
For maximum browser compatibility, the total URL length should not exceed 2048 characters.
Example
https://cdn.orb360.tech/orb360embed/v1.2.5/?tenant=900f7225-ee48-40e7-b51b-39bb77191c1d&endpoint=tag&key=StyleNumber&q=I_AM_A_STYLE_NUMBER,DEF-456&split=,&duration=5000&zoom=true&allowFullscreen=true&playMode=once&hideControls=true&hideAudioControls=false