Embedding

The embed API method provides an oembed endpoint for supported item types (IEmbeddableItem).

Supported item types include the following list:

  • GalleryItem (Photo)

Endpoint URI

https://boxsoci.al/api/oembed

Parameters

url

Required
The short uri of the item to be embedded. The canonical uri of an item is currently not supported.

maxwidth

Optional
The maximum width of the item to be embedded. Values accepted will depend on item type. Default value is 640.

maxheight

Optional
The maximum height of the item to be embedded. Values accepted will depend on item type. Some items may ignore this value. Default value is 640.

format

Optional
The format of the response. Values supported are json and xml.

Example

GET https://boxsoci.al/api/oembed?url=https%3A%2F%2Fboxsoci.al%2Fs%2F69jqVXWnRMY

Code


{
  "type": "photo",
  "version": "1.0",
  "title": "",
  "author_name": "Box Social",
  "author_url": "https://boxsoci.al/group/boxsocial/",
  "provider_name": "Box Social",
  "provider_url": "https://boxsoci.al/",
  "cache_age": "31536000",
  "url": "https://70ddbf748bd67d697849-618a4abe9836fdc5e3c65816efe8923b.ssl.cf4.rackcdn.com/ec7fbe794819b9bd77eba021392a455563224c944eaadd58eb1db6189f63b696a98e53bb83c5d2047c61f5f4fa1b99efdcf54a89d55ac24cbae1828e7f9a2b14",
  "width": "640",
  "height": "640"
}


Last Modified: July 10, 2014 with 42 page views.

This page is licensed under the following license: GNU Free Document License