Iframely API for Responsive Web Embeds
This is the self-hosted version of Iframely's APIs and parsers.
Iframely gives your fast and simple API for responsive web embeds and semantic meta. The parsers cover well over 1800 domains through 200+ custom domain plugins and generic support for oEmbed, Open Graph and Twitter Cards, that are powered by Iframely's whitelist.
The whitelist file is pulled from iframely.com database and is updated automatically. The whitelisting is manual process on our end. You can also have your own whitelist file.
HTTP APIs are available in 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 data samples from hosted API, just to show you the format:
Iframely can also be used as Node.js library (that's how it is used in our cloud API).
Requires Node version 7 and up.
Not included as compared to Cloud API
Hosted cloud APIs add optional iFrame renders and number of widgets such as cards, GIF support, player events, AMP, and others. Our more/less toggle for per-URL customizations, predictive height mechanism for non-iFrame embeds, lazy-loading, type-based whitelist and fallbacks as well as number of other customizations is only available in the cloud.
This open-source version provides the web parsers only, though hosted API uses data from parsers as-is. The API endpoints between the version should match format pretty closely, though there might be minor discrepancies.
There's also a bunch of domain parsers that are not included in self-hosted version. Those are the parsers that we consider vulnarable for changes on publisher's origin servers and so requiring quicker turnaround time for any updates and fixes.
Get started:
To get started with the APIs:
- Your API endpoints will be at
{your.server}/iframely?url=and{your.server}/oembed?url= - How to install & configure your Iframely host.
- API in Iframely format
- API in oEmbed format
- About Link Rels, Types and Media Queries in Iframely format (players, thumbnails, app, reader, survey, slideshow, etc)
- META semantics Iframely API scrapes for you.
- Visual debug tool included in the package is at
{your.server}/debug
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.
Please submit your PR against develop branch. This is where everything gets merged before being released into master.
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-2019 Itteco Software Corp. Nazar Leush, Ivan Paramonau
Please, check the contributors list to get to know awesome folks that also helped a lot.
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent