If you know where you are heading to, use links to the left. Otherwise, read on.
This introduction gives the same links in proper context.
Iframely takes your URL as an input, fetches its semantics from the origin server and tries to return rich media embed codes and other URL data.
If successful, you’ll get
html as embed code that follows your API settings and optional query-string parameters.
If the request fails, you’ll get an error code and a message.
Iframely API follows JSON format. There are (just) two API endpoints available: one follows oEmbed spec, another provides detailed Iframely data.
Think of it as the
<head> of the origin URL with
<meta> and media
Embed.js lets you use Iframely without API calls.
What URLs to send
What to expect as output
Rich media from third-party publishers comes in a variety of types. Many rich media embeds can be used as-is. Some may require an Iframely-hosted iFrame helper to display correctly. For example, React does not add third-party scripts, and you will need to omit scripts.
Customize & fine-tune
You can give your authors our URL options for individual URLs to choose the media variant just the way they want it.
Deliver the content
You should cache API responses, including error codes, on your end and refresh your local data periodically. We recommend cache time-to-live of 1 to 24 hours.
Available integrations & guides
Some Iframely integrations are available. WordPress plugin, Meteor package, Medium-like text editor add-on, [CKEditor] (/docs/ckeditor supports Iframely), NodeBB forums, to mention a few. There are also integration guides for React, Angular and AMP.
If you use of Iframely with Web Components, please read about required Shadow DOM tweaks.