This repository has been archived by the owner on Jan 3, 2024. It is now read-only.
forked from iamcal/oembed
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.htm
620 lines (452 loc) · 30.7 KB
/
index.htm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
<!--
__ __
/\ \ /\ \
___ __ ___ ___\ \ \____ __ \_\ \
/ __`\ /'__`\/' __` __`\ \ '__`\ /'__`\ /'_` \
/\ \L\ \/\ __//\ \/\ \/\ \ \ \L\ \/\ __//\ \L\ \
\ \____/\ \____\ \_\ \_\ \_\ \_,__/\ \____\ \___,_\
\/___/ \/____/\/_/\/_/\/_/\/___/ \/____/\/__,_ /
===== because 'open embed' sounds too dirty =====
Document history
==============================================================
2008-03-21 - original draft created by cal
2008-03-28 - incorporated leah's edits, added security section
2008-04-07 - added implicit format for endpoint URLs
- clarified format and max(width|height) params
- consumers/providers update from leah
2008-04-08 - clarified XML value escaping
2008-05-09 - added optional thumbnail parameters
2008-05-12 - valid JSON would be nice i guess
2008-05-29 - and really valid this time?
- also fixed urlencoding in request examples
2008-07-18 - added discovery section
- more providers
2009-09-21 - removed pownce
- added providers
- added a libraries section
- updated video example (youtube has real support)
2010-10-03 - history is now tracked on github
- http://github.com/iamcal/oembed
-->
<html>
<head>
<title>oEmbed</title>
<style>
body, input, textarea, select {
font-family: Arial,Helvetica,sans-serif;
padding: 20px 50px;
}
#main {
margin: 0 auto;
max-width: 900px;
text-align: left;
}
pre {
background-color: #eee;
border: 1px solid #999;
padding: 8px;
margin: 0px 20px;
}
code {
background-color: #eee;
border: 1px solid #999;
padding: 0px 2px;
}
</style>
</head>
<body>
<div id="main">
<h1>oEmbed</h1>
<p>oEmbed is a format for allowing an embedded representation of a URL on third party sites. The simple API allows a website to display embedded content (such as photos or videos) when a user posts a link to that resource, without having to parse the resource directly.</p>
<p>This document is stored on <a href="https://github.com/iamcal/oembed">github</a>.</p>
<h2>Table Of Contents</h2>
<ol>
<li><a href="#section1">Quick Example<a/></li>
<li><a href="#section2">Full Spec<a/></li>
<li><a href="#section3">Security considerations<a/></li>
<li><a href="#section4">Discovery<a/></li>
<li><a href="#section5">More examples<a/></li>
<li><a href="#section6">Authors<a/></li>
<li><a href="#section7">Implementations<a/></li>
</ol>
<a name="section1" id="section1"><h2>1. Quick Example</h2></a>
<p>A <i>consumer</i> (eg. <a href="http://pownce.com/">Pownce</a>) makes the following HTTP request:</p>
<ul>
<li> <code>http://www.flickr.com/services/oembed/?url=http%3A//www.flickr.com/photos/bees/2341623661/</code> </li>
</ul>
<p>The <i>provider</i> (eg. <a href="http://www.flickr.com/">Flickr</a>) then responds with an oEmbed response:</p>
<pre>{
"version": "1.0",
"type": "photo",
"width": 240,
"height": 160,
"title": "ZB8T0193",
"url": "http://farm4.static.flickr.com/3123/2341623661_7c99f48bbf_m.jpg",
"author_name": "Bees",
"author_url": "http://www.flickr.com/photos/bees/",
"provider_name": "Flickr",
"provider_url": "http://www.flickr.com/"
}</pre>
<p>This allows the consumer to turn a URL to a Flickr photo page into structured data to allow embedding of that photo in the consumer's website.</p>
<a name="section2" id="section2"><h2>2. Full Spec</h2></a>
<p>This spec is broken into three parts - configuration, the consumer request and the provider response.</p>
<p>An oEmbed exchange occurs between a <i>consumer</i> and a <i>provider</i>. A <i>consumer</i> wishes to show an embedded representation of a third party resource on their own web site, such as a photo or an embedded video. A <i>provider</i> implements the oEmbed API to allow <i>consumers</i> to fetch that representation.</p>
<a name="section2.1" id="section2.1"><h3>2.1. Configuration</h3></a>
<p>Configuration for oEmbed is very simple. Providers must specify one or more URL scheme and API endpoint pairs. The URL scheme describes which URLs provided by the service may have an embedded representation. The API endpoint describes where the consumer may request representations for those URLs.</p>
<p>For instance:</p>
<ul>
<li> URL scheme: <code>http://www.flickr.com/photos/*</code> </li>
<li> API endpoint: <code>http://www.flickr.com/services/oembed/</code> </li>
</ul>
<p>The URL scheme may contain one or more wildcards (specified with an asterisk). Wildcards may be present in the domain portion of the URL, or in the path. Within the domain portion, wildcards may only be used for subdomains. Wildcards may not be used in the scheme (to support HTTP and HTTPS, provide two url/endpoint pairs).</p>
<p>Some examples:</p>
<ul>
<li> <code>http://www.flickr.com/photos/*</code> OK </li>
<li> <code>http://www.flickr.com/photos/*/foo/</code> OK </li>
<li> <code>http://*.flickr.com/photos/*</code> OK </li>
<li> <code>http://*.com/photos/*</code> NOT OK </li>
<li> <code>*://www.flickr.com/photos/*</code> NOT OK </li>
</ul>
<p>The API endpoint must point to an HTTP endpoint URL (not HTTPS) which implements the API described below.</p>
<a name="section2.2" id="section2.2"><h3>2.2. Consumer Request</h3></a>
<p>Requests sent to the API endpoint must be HTTP GET requests, with all arguments sent as query parameters. All arguments must be urlencoded (as per RFC 1738).</p>
<p>The following query parameters are defined as part of the spec:</p>
<dl>
<dt><b><code>url</code></b> (required)</dt>
<dd>The URL to retrieve embedding information for.</dd>
<dt><b><code>maxwidth</code></b> (optional)</dt>
<dd>The maximum width of the embedded resource. Only applies to some resource types (as specified below). For supported resource types, this parameter <i>must</i> be respected by providers.</dd>
<dt><b><code>maxheight</code></b> (optional)</dt>
<dd>The maximum height of the embedded resource. Only applies to some resource types (as specified below). For supported resource types, this parameter <i>must</i> be respected by providers.</dd>
<dt><b><code>format</code></b> (optional)</dt>
<dd>The required response format. When not specified, the provider can return any valid response format. When specified, the provider <i>must</i> return data in the request format, else return an error (see below for error codes).</dd>
</dl>
<p>Providers should ignore all other arguments it doesn't expect. Providers are welcome to support custom additional parameters.</p>
<p>Some examples:</p>
<ul>
<li> <code>http://flickr.com/services/oembed?url=http%3A//flickr.com/photos/bees/2362225867/</code> </li>
<li> <code>http://flickr.com/services/oembed?url=http%3A//flickr.com/photos/bees/2362225867/&maxwidth=300&maxheight=400&format=json</code> </li>
</ul>
<p>Note: Providers may choose to have the format specified as part of the endpoint URL itself, rather than as a query string parameter.</p>
<p>For instance:</p>
<ul>
<li> URL scheme: <code>http://www.flickr.com/photos/*</code> </li>
<li> API XML endpoint: <code>http://www.flickr.com/services/oembed.xml</code> </li>
<li> API JSON endpoint: <code>http://www.flickr.com/services/oembed.json</code> </li>
</ul>
<p>In this case, the format parameter is not needed and will be ignored. When a provider publishes a URL scheme and API endpoint pair, they should clearly state whether the format is implicit in the endpoint or if it needs to be passed as an argument.</p>
<a name="section2.3" id="section2.3"><h3>2.3. Provider Response</h3></a>
<p>The response returned by the provider can be in either JSON or XML. Each format specifies a way of encoding name-value pairs which comprise the response data. Each format has an associated mime-type which must be returned in the <code>Content-type</code> header along with the response.</p>
<h4>2.3.1. JSON response</h4>
<p>JSON responses must contain well formed <a href="http://json.org/">JSON</a> and must use the mime-type of <code>application/json</code>. The JSON response format may be requested by the consumer by specifying a <code>format</code> of <code>json</code>.</p>
<p>For example:</p>
<pre>{
"foo": "bar",
"baz": 1
}</pre>
<p>The key-value pairs to be returned are specified below. All text must be UTF-8 encoded.</p>
<h4>2.3.2. XML response</h4>
<p>XML responses must use the mime-type of <code>text/xml</code>. The XML response format may be requested by the consumer by specifying a <code>format</code> of <code>xml</code>. The response body must contain well formed XML with a root element called <code>oembed</code> and child elements for each key containing the value within the element body. For example:</p>
<pre><?xml version="1.0" encoding="utf-8" standalone="yes"?>
<oembed>
<foo>bar</foo>
<baz>1</baz>
</oembed></pre>
<p>The key-value pairs to be returned are specified below. All text must be UTF-8 encoded. Values should be escaped PCDATA. For example:</p>
<pre><?xml version="1.0" encoding="utf-8" standalone="yes"?>
<oembed>
<html>&lt;b&gt;awesome!&lt;/b&gt;</html>
</oembed></pre>
<h4>2.3.4. Response parameters</h4>
<p>Responses can specify a resource type, such as <code>photo</code> or <code>video</code>. Each type has specific parameters associated with it. The following response parameters are valid for all response types:</p>
<dl>
<dt><b><code>type</code></b> (required)</dt>
<dd>The resource type. Valid values, along with value-specific parameters, are described below.</dd>
<dt><b><code>version</code></b> (required)</dt>
<dd>The oEmbed version number. This must be <code>1.0</code>.</dd>
<dt><b><code>title</code></b> (optional)</dt>
<dd>A text title, describing the resource.</dd>
<dt><b><code>author_name</code></b> (optional)</dt>
<dd>The name of the author/owner of the resource.</dd>
<dt><b><code>author_url</code></b> (optional)</dt>
<dd>A URL for the author/owner of the resource.</dd>
<dt><b><code>provider_name</code></b> (optional)</dt>
<dd>The name of the resource provider.</dd>
<dt><b><code>provider_url</code></b> (optional)</dt>
<dd>The url of the resource provider.</dd>
<dt><b><code>cache_age</code></b> (optional)</dt>
<dd>The <i>suggested</i> cache lifetime for this resource, in seconds. Consumers may choose to use this value or not.</dd>
<dt><b><code>thumbnail_url</code></b> (optional)</dt>
<dd>A URL to a thumbnail image representing the resource. The thumbnail must respect any <code>maxwidth</code> and <code>maxheight</code> parameters. If this paramater is present, <code>thumbnail_width</code> and <code>thumbnail_height</code> must also be present.</dd>
<dt><b><code>thumbnail_width</code></b> (optional)</dt>
<dd>The width of the optional thumbnail. If this paramater is present, <code>thumbnail_url</code> and <code>thumbnail_height</code> must also be present.</dd>
<dt><b><code>thumbnail_height</code></b> (optional)</dt>
<dd>The height of the optional thumbnail. If this paramater is present, <code>thumbnail_url</code> and <code>thumbnail_width</code> must also be present.</dd>
</dl>
<p>Providers may optionally include any parameters not specified in this document (so long as they use the same key-value format) and consumers may choose to ignore these. Consumers must ignore parameters they do not understand.</p>
<h4>2.3.4.1. The <code>photo</code> type</h4>
<p>This type is used for representing static photos. The following parameters are defined:</p>
<dl>
<dt><b><code>url</code></b> (required)</dt>
<dd>The source URL of the image. Consumers should be able to insert this URL into an <code><img></code> element. Only HTTP and HTTPS URLs are valid.</dd>
<dt><b><code>width</code></b> (required)</dt>
<dd>The width in pixels of the image specified in the <code>url</code> parameter.</dd>
<dt><b><code>height</code></b> (required)</dt>
<dd>The height in pixels of the image specified in the <code>url</code> parameter.</dd>
</dl>
<p>Responses of this type must obey the <code>maxwidth</code> and <code>maxheight</code> request parameters.</p>
<h4>2.3.4.2. The <code>video</code> type</h4>
<p>This type is used for representing playable videos. The following parameters are defined:</p>
<dl>
<dt><b><code>html</code></b> (required)</dt>
<dd>The HTML required to embed a video player. The HTML should have no padding or margins. Consumers may wish to load the HTML in an off-domain iframe to avoid XSS vulnerabilities.</dd>
<dt><b><code>width</code></b> (required)</dt>
<dd>The width in pixels required to display the HTML.</dd>
<dt><b><code>height</code></b> (required)</dt>
<dd>The height in pixels required to display the HTML.</dd>
</dl>
<p>Responses of this type must obey the <code>maxwidth</code> and <code>maxheight</code> request parameters. If a provider wishes the consumer to just provide a thumbnail, rather than an embeddable player, they should instead return a <code>photo</code> response type.</p>
<h4>2.3.4.3. The <code>link</code> type</h4>
<p>Responses of this type allow a provider to return any generic embed data (such as <code>title</code> and <code>author_name</code>), without providing either the url or html parameters. The consumer may then link to the resource, using the URL specified in the original request.</p>
<h4>2.3.4.4. The <code>rich</code> type</h4>
<p>This type is used for rich HTML content that does not fall under one of the other categories. The following parameters are defined:</p>
<dl>
<dt><b><code>html</code></b> (required)</dt>
<dd>The HTML required to display the resource. The HTML should have no padding or margins. Consumers may wish to load the HTML in an off-domain iframe to avoid XSS vulnerabilities. The markup should be valid XHTML 1.0 Basic.</dd>
<dt><b><code>width</code></b> (required)</dt>
<dd>The width in pixels required to display the HTML.</dd>
<dt><b><code>height</code></b> (required)</dt>
<dd>The height in pixels required to display the HTML.</dd>
</dl>
<p>Responses of this type must obey the <code>maxwidth</code> and <code>maxheight</code> request parameters.</p>
<h4>2.3.5. Errors</h4>
<p>Providers should return any error conditions as HTTP status codes. The following status codes are defined as part of the oEmbed specification:</p>
<dl>
<dt><b><code>404 Not Found</code></b></dt>
<dd>The provider has no response for the requested <code>url</code> parameter. This allows providers to be broad in their URL scheme, and then determine at call time if they have a representation to return.</dd>
<dt><b><code>501 Not Implemented</code></b></dt>
<dd>The provider cannot return a response in the requested format. This should be sent when (for example) the request includes <code>format=xml</code> and the provider doesn't support XML responses. However, providers are encouraged to support both JSON and XML.</dd>
<dt><b><code>401 Unauthorized</code></b></dt>
<dd>The specified URL contains a private (non-public) resource. The consumer should provide a link directly to the resource instead of any embedding any extra information, and rely on the provider to provide access control.</dd>
</dl>
<a name="section3" id="section3"><h2>3. Security considerations</h2></a>
<p>When a consumer displays any URLs, they will probably want to filter the URL scheme to be one of <code>http</code>, <code>https</code> or <code>mailto</code>, although providers are free to specify any valid URL. Without filtering, <code>Javascript:...</code> style URLs could be used for XSS attacks.</p>
<p>When a consumer displays HTML (as with video embeds), there's a vector for XSS attacks from the provider. To avoid this, it is recommended that consumers display the HTML in an <code>iframe</code>, hosted from another domain. This ensures that the HTML cannot access cookies from the consumer domain.</p>
<a name="section4" id="section4"><h2>4. Discovery</h2></a>
<p>oEmbed providers can choose to make their oEmbed support discoverable by adding elements to the head of their existing (X)HTML documents.</p>
<p>For example:</p>
<pre>
<link rel="alternate" type="application/json+oembed"
href="http://flickr.com/services/oembed?url=http%3A//flickr.com/photos/bees/2362225867/&format=json"
title="Bacon Lollys oEmbed Profile" />
<link rel="alternate" type="text/xml+oembed"
href="http://flickr.com/services/oembed?url=http%3A//flickr.com/photos/bees/2362225867/&format=xml"
title="Bacon Lollys oEmbed Profile" />
</pre>
<p>The URLs contained within the <code>href</code> attribute should be the full oEmbed endpoint plus URL and any needed format parameter. No other request parameters should be included in this URL.</p>
<p>The <code>type</code> attribute must contain either <code>application/json+oembed</code> for JSON responses, or <code>text/xml+oembed</code> for XML.</p>
<a name="section5" id="section5"><h2>5. More examples</h2></a>
<a name="section5.1" id="section5.1"><h3>5.1. Video example</h3></a>
<p>Request:</p>
<pre>http://www.youtube.com/oembed?url=http%3A//youtube.com/watch%3Fv%3DM3r2XDceM6A&format=json</pre>
<p>Response:</p>
<pre>{
"version": "1.0",
"type": "video",
"provider_name": "YouTube",
"provider_url": "http://youtube.com/",
"width": 425,
"height": 344,
"title": "Amazing Nintendo Facts",
"author_name": "ZackScott",
"author_url": "http://www.youtube.com/user/ZackScott",
"html":
"<object width=\"425\" height=\"344\">
<param name=\"movie\" value=\"http://www.youtube.com/v/M3r2XDceM6A&fs=1\"></param>
<param name=\"allowFullScreen\" value=\"true\"></param>
<param name=\"allowscriptaccess\" value=\"always\"></param>
<embed src=\"http://www.youtube.com/v/M3r2XDceM6A&fs=1\"
type=\"application/x-shockwave-flash\" width=\"425\" height=\"344\"
allowscriptaccess=\"always\" allowfullscreen=\"true\"></embed>
</object>",
}</pre>
<a name="section5.2" id="section5.2"><h3>5.2. Link example</h3></a>
<p>Request:</p>
<pre>http://iamcal.com/oembed/?url=http%3A//www.iamcal.com/linklog/1206113631/&format=xml</pre>
<p>Response:</p>
<pre><?xml version="1.0" encoding="utf-8" standalone="yes"?>
<oembed>
<version>1.0</version>
<type>link</type>
<author_name>Cal Henderson</author_name>
<author_url>http://iamcal.com/</author_url>
<cache_age>86400</cache_age>
<provider_name>iamcal.com</author_name>
<provider_url>http://iamcal.com/</provider_url>
</oembed></pre>
<a name="section6" id="section6"><h2>6. Authors</h2></a>
<ul>
<li>Cal Henderson (cal [at] iamcal.com)</li>
<li>Mike Malone (mjmalone [at] gmail.com)</li>
<li>Leah Culver (leah.culver [at] gmail.com)</li>
<li>Richard Crowley (r [at] rcrowley.org)</li>
</ul>
<a name="section7" id="section7"><h2>7. Implementations</h2></a>
<a name="section7.1" id="section7.1"><h3>7.1. Providers</h3></a>
<p>YouTube (<a href="http://www.youtube.com/">http://www.youtube.com/</a>)</p>
<ul>
<li> API endpoint: <code>http://www.youtube.com/oembed</code> </li>
<li> Supports discovery via <code><link></code> tags </li>
<li> Example: <a href="http://www.youtube.com/oembed?url=http%3A//www.youtube.com/watch?v%3D-UUx10KOWIE&format=xml">http://www.youtube.com/oembed?url=http%3A//www.youtube.com/watch?v%3D-UUx10KOWIE&format=xml</a></li>
</ul>
<p>Flickr (<a href="http://www.flickr.com/">http://www.flickr.com/</a>)</p>
<ul>
<li> URL scheme: <code>http://*.flickr.com/*</code> </li>
<li> API endpoint: <code>http://www.flickr.com/services/oembed/</code> </li>
<li> Example: <a href="http://flickr.com/services/oembed?url=http%3A//flickr.com/photos/bees/2362225867/">http://flickr.com/services/oembed?url=http%3A//flickr.com/photos/bees/2362225867/</a></li>
</ul>
<p>Viddler (<a href="http://www.viddler.com/">http://www.viddler.com/</a>)</p>
<ul>
<li> URL scheme: <code>http://*.viddler.com/*</code> </li>
<li> API endpoint: <code>http://lab.viddler.com/services/oembed/</code> </li>
<li> Documentation: <a href="http://wiki.developers.viddler.com/index.php/OEMBED">http://wiki.developers.viddler.com/index.php/OEMBED</a> </li>
<li> Example: <a href="http://lab.viddler.com/services/oembed/?url=http%3A//www.viddler.com/explore/cdevroe/videos/424/">http://lab.viddler.com/services/oembed/?url=http%3A//www.viddler.com/explore/cdevroe/videos/424/</a> </li>
</ul>
<p>Qik (<a href="http://qik.com/">http://qik.com/</a>)</p>
<ul>
<li> URL scheme (videos): <code>http://qik.com/video/*</code> </li>
<li> URL scheme (user channels): <code>http://qik.com/*</code> </li>
<li> API endpoint: <code>http://qik.com/api/oembed.{format}</code> </li>
<li> Example: <a href="http://qik.com/api/oembed.xml?url=http%3A//qik.com/video/49565">http://qik.com/api/oembed.xml?url=http%3A//qik.com/video/49565</a> </li>
</ul>
<p>Revision3 (<a href="http://revision3.com/">http://revision3.com/</a>)</p>
<ul>
<li> URL scheme: <code>http://*.revision3.com/*</code> </li>
<li> API endpoint: <code>http://revision3.com/api/oembed/</code> </li>
<li> Example: <a href="http://revision3.com/api/oembed/?url=http%3A//revision3.com/diggnation/2008-04-17xsanned/&format=xml">http://revision3.com/api/oembed/?url=http%3A//revision3.com/diggnation/2008-04-17xsanned/&format=xml</a> </li>
</ul>
<p>Hulu (<a href="http://www.hulu.com/">http://www.hulu.com/</a>)</p>
<ul>
<li> URL scheme: <code>http://www.hulu.com/watch/*</code> </li>
<li> API endpoint: <code>http://www.hulu.com/api/oembed.{format}</code> </li>
<li> Example: <a href="http://www.hulu.com/api/oembed.xml?url=http%3A//www.hulu.com/watch/20807/late-night-with-conan-obrien-wed-may-21-2008">http://www.hulu.com/api/oembed.xml?url=http%3A//www.hulu.com/watch/20807/late-night-with-conan-obrien-wed-may-21-2008</a> </li>
</ul>
<p>Vimeo (<a href="http://vimeo.com/">http://vimeo.com/</a>)</p>
<ul>
<li> Docs: <a href="http://vimeo.com/api/docs/oembed">http://vimeo.com/api/docs/oembed</a> </li>
<li> URL scheme (video): <code>http://vimeo.com/*</code> </li>
<li> URL scheme (group video): <code>http://vimeo.com/groups/*/videos/*</code> </li>
<li> Endpoint: <code>http://vimeo.com/api/oembed.{format}</code> </li>
<li> Example: <a href="http://vimeo.com/api/oembed.xml?url=http%3A//vimeo.com/7100569">http://vimeo.com/api/oembed.xml?url=http%3A//vimeo.com/7100569</a> </li>
</ul>
<p>CollegeHumor (<a href="http://www.collegehumor.com/">http://www.collegehumor.com/</a>)</p>
<ul>
<li> URL scheme (videos): <code>http://www.collegehumor.com/video/*</code> </li>
<li> API Endpoint: <code>http://www.collegehumor.com/oembed.{format}</code> </li>
<li> Example: <a href="http://www.collegehumor.com/oembed.xml?url=http%3A%2F%2Fwww.collegehumor.com%2Fvideo%2F3922232%2Fprank-war-7-the-half-million-dollar-shot">http://www.collegehumor.com/oembed.xml?url=http%3A%2F%2Fwww.collegehumor.com%2Fvideo%2F3922232%2Fprank-war-7-the-half-million-dollar-shot</a> </li>
<li> Supports discovery via <code><link></code> tags </li>
</ul>
<p>oohEmbed (<a href="http://oohembed.com/">http://oohembed.com/</a>)</p>
<ul>
<li> URL scheme: Various (see docs) </li>
<li> Endpoint: <code>http://oohembed.com/oohembed/</code> </li>
<li> Example: <a href="http://oohembed.com/oohembed/?url=http%3A//www.amazon.com/Myths-Innovation-Scott-Berkun/dp/0596527055/">http://oohembed.com/oohembed/?url=http%3A//www.amazon.com/Myths-Innovation-Scott-Berkun/dp/0596527055/</a> </li>
</ul>
<p>Poll Everywhere (<a href="http://www.polleverywhere.com/">http://www.polleverywhere.com/</a>)</p>
<ul>
<li> URL scheme: <code>http://www.polleverywhere.com/polls/*</code> </li>
<li> URL scheme: <code>http://www.polleverywhere.com/multiple_choice_polls/*</code> </li>
<li> URL scheme: <code>http://www.polleverywhere.com/free_text_polls/*</code> </li>
<li> API endpoint: <code>http://www.polleverywhere.com/services/oembed/</code> </li>
<li> Documentation: <a href="http://api.polleverywhere.com/index.php?title=OEmbed">http://api.polleverywhere.com/index.php?title=OEmbed</a> </li>
<li> Example: <a href="http://polleverywhere.com/services/oembed?url=http://www.polleverywhere.com/multiple_choice_polls/LTIwNzM1NTczNTE&format=xml">http://polleverywhere.com/services/oembed?url=http://www.polleverywhere.com/multiple_choice_polls/LTIwNzM1NTczNTE&format=xml</a> </li>
</ul>
<p>My Opera (<a href="http://my.opera.com/">http://my.opera.com/</a>)</p>
<ul>
<li> API endpoint: <code>http://my.opera.com/service/oembed</code> </li>
<li> Documentation: <a href="http://my.opera.com/devblog/blog/2008/12/02/embedding-my-opera-content-oembed">http://my.opera.com/devblog/blog/2008/12/02/embedding-my-opera-content-oembed</a> </li>
<li> Example: <a href="http://my.opera.com/service/oembed/?url=http%3A%2F%2Fmy.opera.com%2Fcstrep%2Falbums%2Fshow.dml?id%3D504322">http://my.opera.com/service/oembed/?url=http%3A%2F%2Fmy.opera.com%2Fcstrep%2Falbums%2Fshow.dml?id%3D504322</a> </li>
</ul>
<p> Embedly (<a href="http://api.embed.ly/">http://api.embed.ly</a>)</p>
<ul>
<li> URL scheme: Various (see docs) </li>
<li> API endpoint: <code>http://api.embed.ly/1/oembed</code> </li>
<li> Documentation: <a href="http://api.embed.ly/documentation">http://api.embed.ly/documentation</a>
<li> Example: <a href="http://api.embed.ly/1/oembed?url=http://www.youtube.com/watch%3Fv%3DB-m6JDYRFvk">http://api.embed.ly/1/oembed?url=http://www.youtube.com/watch%3Fv%3DB-m6JDYRFvk</a></li>
</ul>
<p> iFixit (<a href="http://www.iFixit.com">http://www.iFixit.com</a>)</p>
<ul>
<li> URL scheme: <code>http://www.ifixit.com/Guide/View/*</code> </li>
<li> Endpoint: <code>http://www.ifixit.com/Embed</code> </li>
<li> Documentation: <a href="http://www.ifixit.com/api/doc/embed">http://www.ifixit.com/api/doc/embed</a> </li>
<li> Example: <a href="http://www.ifixit.com/Embed?url=http%3A%2F%2Fwww.ifixit.com%2FTeardown%2FiPhone-4-Teardown%2F3130%2F1&format=json">http://www.ifixit.com/Embed?url=http%3A%2F%2Fwww.ifixit.com%2FTeardown%2FiPhone-4-Teardown%2F3130%2F1&format=json</a> </li>
</ul>
<p> SmugMug (<a href="http://www.smugmug.com/">http://www.smugmug.com/</a>)</p>
<ul>
<li> URL Scheme: <code>http://*.smugmug.com/*</code> </li>
<li> URL Scheme: <code>http://*.example.com/*</code> (where example.com = SmugMug customer domain) </li>
<li> Endpoint: <code>http://api.smugmug.com/services/oembed/</code> </li>
<li> Documentation: <a href="http://wiki.smugmug.net/display/API/oEmbed">http://wiki.smugmug.net/display/API/oEmbed</a> </li>
<li> Example: <a href="http://api.smugmug.com/services/oembed/?url=http://www.smugmug.com/popular/all%23125787395_hQSj9">http://api.smugmug.com/services/oembed/?url=http://www.smugmug.com/popular/all%23125787395_hQSj9</a> </li>
<li> Supports discovery via <link> tags </li>
</ul>
<p> SlideShare (<a href="http://www.slideshare.net/">http://www.slideshare.net/</a>)</p>
<ul>
<li> URL Scheme: <code>http://www.slideshare.net/*/*</code> </li>
<li> Endpoint: <code>http://www.slideshare.net/api/oembed/2</code> </li>
<li> Documentation: <a href="http://www.slideshare.net/developers/oembed">http://www.slideshare.net/developers/oembed</a> </li>
<li> Example: <a href="http://www.slideshare.net/api/oembed/2?url=http://www.slideshare.net/haraldf/business-quotes-for-2011&format=json">http://www.slideshare.net/api/oembed/2?url=http://www.slideshare.net/haraldf/business-quotes-for-2011&format=json</a> </li>
<li> Supports discovery via <link> tags </li>
</ul>
<p>WordPress.com (<a href="http://wordpress.com/">http://wordpress.com/</a>)</p>
<ul>
<li>Endpoint: <code>http://public-api.wordpress.com/oembed/</code></li>
<li>Documentation: <a href="http://develop.wordpress.com/oembed-provider-api/">http://develop.wordpress.com/oembed-provider-api/</a></li>
<li>Example: <a href="http://public-api.wordpress.com/oembed/1.0/?format=json&url=http%3A%2F%2Fmatt.wordpress.com%2F2011%2F07%2F14%2Fclouds-over-new-york%2F&for=oembed.com">http://public-api.wordpress.com/oembed/1.0/?format=json&url=http%3A%2F%2Fmatt.wordpress.com%2F2011%2F07%2F14%2Fclouds-over-new-york%2F&for=oembed.com</a></li>
<li>Supports discovery via <link> tags</li>
</ul>
<a name="section7.2" id="section7.2"><h3>7.2. Consumers</h3></a>
<p>To have a particular consumer display your OEmbed, please contact the consumer with your provider's URL scheme and API endpoint.</p>
<p>Buckybase (<a href="http://buckybase.appspot.com/">http://buckybase.appspot.com/</a>)</p>
<ul>
<li> Contact: Manuel Simoni (msimoni [at] gmail.com)</li>
</ul>
<p>280 Slides (<a href="http://280slides.com/">http://280slides.com/</a>)</p>
<ul>
<li> Contact: Ross Boucher (rboucher [at] gmail.com)</li>
</ul>
<p>Dumble (<a href="http://oohembed.com/dumble/">http://oohembed.com/dumble/</a>)</p>
<ul>
<li> Contact: Deepak Sarda (deepak.sarda [at] gmail.com)</li>
</ul>
<a name="section7.3" id="section7.3"><h3>7.3. Libraries</h3></a>
<ul>
<li>PHP: php-oembed (<a href="http://code.google.com/p/php-oembed/">http://code.google.com/p/php-oembed/</a>)</li>
<li>PHP: Services_oEmbed (<a href="http://pear.php.net/package/Services_oEmbed">http://pear.php.net/package/Services_oEmbed</a>)</li>
<li>Perl: Web-oEmbed (<a href="http://search.cpan.org/~miyagawa/Web-oEmbed/">http://search.cpan.org/~miyagawa/Web-oEmbed/</a>)</li>
<li>Ruby: oembed_links (<a href="http://github.com/netshade/oembed_links">http://github.com/netshade/oembed_links</a>)</li>
<li>Python oEmbed (<a href="http://code.google.com/p/python-oembed/">http://code.google.com/p/python-oembed/</a>)</li>
<li>Django: djangoembed (<a href="http://github.com/worldcompany/djangoembed">http://github.com/worldcompany/djangoembed</a>)</li>
<li>Java: java-oembed (<a href="https://github.com/michael-simons/java-oembed">https://github.com/michael-simons/java-oembed</a>)</li>
<li>.Net: oEmbed API Wrapper (<a href="http://oembed.codeplex.com/">http://oembed.codeplex.com/</a>)</li>
<li>JQuery: oEmbed API Wrapper (<a href="https://github.com/starfishmod/jquery-oembed-all">https://github.com/starfishmod/jquery-oembed-all</a>)</li>
</ul>
<hr />
<a name="links" id="links"><h3>Press and Links</h3></a>
<ul>
<li><a href="http://groups.google.com/group/oembed/">The official oEmbed mailing list</a></li>
</ul>
<ul>
<li><a href="http://www.webmonkey.com/tutorial/Get_Started_With_OEmbed">Webmonkey tutorial</a></li>
<li><a href="http://leahculver.com/2008/05/29/announcing-oembed-an-open-standard-for-embedded-content/">Leah's blog</a></li>
<li><a href="http://www.readwriteweb.com/archives/oembed_open_format.php" target="_blank">ReadWriteWeb</a></li>
<li><a href="http://developer.yahoo.net/blog/archives/2008/05/oembed_embeddin.html">Yahoo! Developer Network</a></li>
<li><a href="http://ajaxian.com/archives/oembed-makes-embedding-third-party-videos-and-images-a-breeze">ajaxian</a></li>
<li><a href="http://blog.hulu.com/2008/5/27/sharing-is-easy" target="_blank">Hulu blog</a></li>
<li><a href="http://qik.com/blog/124/qik-embraces-oembed-for-embedding-videos">Qik blog</a></li>
</ul>
<p>This document is stored on <a href="https://github.com/iamcal/oembed">github</a>.
Please check the <a href="http://groups.google.com/group/oembed/">mailing list</a>, fork and contribute.</p>
</div>
</body>
</html>