oEmbed endpoint
Podigee supports the oEmbed format to programmatically fetch embed information for podcast episodes.
From the oEmbed website:
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.
Specification
URL schemes
- http://*.podigee.io/*
- https://*.podigee.io/*
Additionally we support custom domains pointing to podcast websites on Podigee and external Episode URLs as configured on the episode to embed (see examples below).
API Endpoint
All requests need to be made to the following endpoint: https://embed.podigee.com/oembed.
Supported query parameters
- url - The URL to retrieve embedding information for
- type - [optional] The type of embed; valid values: script, iframe; defaults to script
Examples
Podigee website subdomains
https://embed.podigee.com/oembed?url=http://example.podigee.io/1-first-episode
Episode URL | oEmbed URL |
https://example.podigee.io/1-first-episode |
https://embed.podigee.com/oembed?url=https://example.podigee.io/1-first-episode |
http://example.podigee.io/1-first-episode | https://embed.podigee.com/oembed?url=http://example.podigee.io/1-first-episode |
Custom domains
Episode URL | oEmbed URL |
http://my-podcast.com/first-episode | https://embed.podigee.com/oembed?url=http://my-podcast.com/first-episode |
https://my-podcast.com/first-episode | https://embed.podigee.com/oembed?url=https://my-podcast.com/first-episode |
External episode URLs
Episode URL | oEmbed URL |
http://my-own-podcast-site.com/an-episode | https://embed.podigee.com/oembed?url=http://my-own-podcast-site.com/an-episode |
https://my-own-podcast-site.com/an-episode | https://embed.podigee.com/oembed?url=https://my-own-podcast-site.com/an-episode |
Iframe embed
Episode URL | oEmbed URL |
http://example.podigee.io/1-first-episode |
https://embed.podigee.com/oembed?url=http://example.podigee.io/1-first-episode&type=iframe |
Responses
Script embed
# https://embed.podigee.com/oembed?url=https://example.podigee.io/1-episode-one { author_name: "Joe Podcaster", description: "Episode description.", height: "105", width: "100%", html: "<script class="podigee-podcast-player" src="https://cdn.podigee.com/podcast-player/javascripts/podigee-podcast-player.js" data-configuration="https://example.podigee.io/1-episode-one/embed"></script>", provider_name: "Podigee", provider_url: "https://www.podigee.com", thumbnail_url: "https://cdn.podigee.com/uploads/u1154/5a8517d4-34b1-43ff-b81b-8bed339d81c4.jpg", title: "Episode title", type: "rich", url: "https://example.podigee.io/1-episode-one", version: "1.0" }
Iframe embed
# https://embed.podigee.com/oembed?url=https://example.podigee.io/1-episode-one&type=iframe { author_name: "Joe Podcaster", description: "Episode description.", height: "105", width: "100%", html: "<iframe class="podigee-podcast-player" src="https://example.podigee.io/1-episode-one/embed"></iframe>", provider_name: "Podigee", provider_url: "https://www.podigee.com", thumbnail_url: "https://cdn.podigee.com/uploads/u1154/5a8517d4-34b1-43ff-b81b-8bed339d81c4.jpg", title: "Episode title", type: "rich", url: "https://example.podigee.io/1-episode-one", version: "1.0" }