Skip to content

Latest commit

 

History

History
58 lines (31 loc) · 3.48 KB

README.md

File metadata and controls

58 lines (31 loc) · 3.48 KB

Iframely API for Responsive Web Embeds

Iframely is fast and simple HTTP API for responsive web embeds and semantic meta. The API covers well over 1600 domains through 150 custom domain plugins and generic parsers for oEmbed, Open Graph and Twitter Cards, powered by Iframely's whitelist.

The whitelisting is manual process, and we do every-day manual regression testing to ensure integrity. Submit your domain, if you publish embeds.

HTTP API are available as oEmbed or Iframely API formats. To make it simple to understand, Iframely format mimics the <head> section of the page with its meta and links elements.

In response to url request, APIs returns you the embeds and meta for a requested web page. Below are samples from hosted API, just to show you the format:

Iframely can also be used as Node.js library. Requires Node version 0.10.22 and up.

Get started:

The simplest way to see Iframely in action is by using our Chrome plugin. This way you will see the embeds on your (or any really) site right away (but not on GitHub due to Content-Security-Policy, sorry).

Or, try Iframely demo with your very own or any other Twitter feed. Don't forget to click on results to see the embed codes.

To get started with the APIs:

Use APIs in your open-source project

We have provided specific endpoint for the use in open source projects. Read more at oembedapi.com.

Contribute

We put our best effort to maintain Iframely and all its domain parsers. Please, feel free to reach us on Twitter or to submit an issue if you have any suggestions. Our support email is support at iframely.com

Fork and pull-request, if you'd like to add more plugins and/or contribute fixes or improvements. By doing so, you make your work available under the same MIT license.

If you see an error in our domains whitelist (you can debug URLs here), please ping us and we'll fix it in no time.

License & Authors

MIT License. (c) 2012-2015 Itteco Software Corp.

Specifically:

Please, check the contributors list to get to know awesome folks that also helped a lot.