Skip to content
Dovy Paukstys edited this page Feb 12, 2015 · 2 revisions

Discovery

Embed the following to each page which supports oembed using this speck.

<link rel="alternate" type="application/json+oembed" href="http://flickr.com/services/oembed?url=http%3A%2F%2Fflickr.com%2Fphotos%2Fbees%2F2362225867%2F&format=json" title="Bacon Lollys oEmbed Profile" />

<link rel="alternate" type="text/xml+oembed" href="http://flickr.com/services/oembed?url=http%3A%2F%2Fflickr.com%2Fphotos%2Fbees%2F2362225867%2F&format=xml" title="Bacon Lollys oEmbed Profile" />

Format

We follow the base oEmbed requirements as outlined here.

Key Required Type Description
type yes string The resource type. Valid values, along with value-specific parameters, are described below. We strongly suggest using the rich type.
version yes string The oEmbed version number. This must be 1.0.
title yes string A text title, describing the resource.
author_name no string The name of the author/owner of the resource.
author_url no string A URL for the author/owner of the resource.
provider_name no string The name of the resource provider.
provider_url no string The url of the resource provider.
cache_age no string The suggested cache lifetime for this resource, in seconds. Consumers may choose to use this value or not.
thumbnail_url no string A URL to a thumbnail image representing the resource. The thumbnail must respect any maxwidth and maxheight parameters. If this parameter is present, thumbnail_width and thumbnail_height must also be present.
thumbnail_width no string The width of the optional thumbnail. If this parameter is present, thumbnail_url and thumbnail_height must also be present.
thumbnail_height no string The height of the optional thumbnail. If this parameter is present, thumbnail_url and thumbnail_width must also be present.

We further enhance the oEmbed protocol with the following fields:

Key Required Type Description
url yes string Return the preferred URL for this source.
long_live_url no string A canonical url for long lived IDs.
citation yes string A full source citation.
collection no string Collection of this source.
record_contains no array An array of the following types: transcript, media, persona
Clone this wiki locally