API
Informationen zu unserer Programmierschnittstelle (API)
Über die podcast.de API
Unsere Programmierschnittstelle (API) bietet die Möglichkeit auf unseren redaktionell bearbeiteten Datenbestand an Podcasts (RSS-Feeds) und Episoden zuzugreifen. Wir bieten hierfür verschiedene, definierte Schnittstellen (XML, JSON, RSS, OPML) an.
Beachten Sie bitte, dass unsere API zur Zeit nicht öffentlich ist. Wenn Sie Interesse am Zugriff auf unsere API haben, kontaktieren Sie uns bitte. Nennen Sie uns bitte den gewünschten Verwendungszeck (kommerziell / nicht-kommerziell), die Anzahl der zu erwartenden Zugriffe und Ihre Kontaktdaten, damit wir mit Ihnen in Verbindung treten können.
API Authentifizierung
Für den Zugriff auf unsere API benötigen Sie einen API-Schlüssel. Sie bekommen den API-Schlüssel mit den Zugangsinformationen nach Rücksprache. Bitte beachten Sie, dass die Integration unserer API für kommerzielle Dienste kostenpflichtig ist. Die Nutzung setzt den Erwerb eines Dienstleistungsproduktes von podcast.de voraus.
Bei der Kommunikation über die API muss der API-Schlüssel mit jedem Aufruf als Parameter api_key mitgeteilt werden.
REST API Dokumentation
Die folgenden Methoden stehen aktuell über unsere API zur Verfügung. Gerne können Sie Vorschläge für weitere Funktionen einreichen oder uns wegen der Machbarkeit für bestimmte Abfragen kontaktieren.
api/category/
Liefert eine Liste von Podcasts zu einer Kategorie. In der Liste stehen zusätzlich, sofern vorhanden, noch die Unterkategorien der ausgewählten Kategorie. Jede Unterkategorie ist mit einer ID gekennzeichnet. Diese ID kann wiederum als category_id verwendet werden, um Daten zu der Kategorie zu holen. Wenn keine Kategorie explizit angegeben ist, ist das Ergebnis nicht auf eine bestimmte Kategorie eingegrenzt.
URL
http://api.podcast.de/api/category/
Formate
XML, JSON, OPML
HTTP Methode(n)
GET
Parameter
- api_key
- Pflicht. Siehe Authentifizierung.
- format
- Optional. Default ist XML. Gültige Werte: Siehe Formate.
- start_index
- Optional. Default ist 0. Gültige Werte: Positiver Integer.
- limit
- Optional. Default ist 100. Gültige Werte: Positiver Integer.
- category_id
- Optional. Default ist 0. Gültige Werte: Positiver Integer.
- channel_type
- Optional. Default is AUDIO. Gültige Werte: AUDIO, VIDEO, ALL.
Beispiele
- Hole eine Liste von 5 Audio-Podcasts aus allen Kategorien im XML-Format. http://api.podcast.de/api/category/?limit=5&api_key=IHR_API_SCHLUESSEL
- Hole eine OPML-Liste von Video-Podcasts aus der Kategorie Politik (517) http://api.podcast.de/api/category/?format=OPML&category_id=517&channel_type=VIDEO&api_key=IHR_API_SCHLUESSEL
- Hole 10 Podcasts von beliebigem Typ in der Kategorie Medizin (224) beginnend ab dem 50. Treffer im JSON Format http://api.podcast.de/api/category/?format=JSON&category_id=224&channel_type=ALL&start_index=50&api_key=IHR_API_SCHLUESSEL
api/charts/climber/
Es wird eine Liste von Podcasts (RSS-Feeds) zurückgeliefert. Die Sortierung erfolgt nach einem geheimen Algorithmus. Das Ergebnis entspricht den Aufsteigern bei den Charts der Webseite.
URL
http://api.podcast.de/api/charts/climber/
Formate
XML, RSS, OPML
HTTP Methode(n)
GET
Parameter
- api_key
- Pflicht. Siehe Authentifizierung.
- format
- Optional. Default ist XML. Gültige Werte: Siehe Formate.
- start_index
- Optional. Default ist 0. Gültige Werte: Positiver Integer.
- limit
- Optional. Default ist 100. Gültige Werte: Positiver Integer.
- channel_type
- Optional. Default is AUDIO. Gültige Werte: AUDIO, VIDEO, ALL.
Beispiele
- Hole Liste von Aufsteiger-Podcasts (RSS-Feeds) vom Typ Audio im XML-Format http://api.podcast.de/api/charts/climber/?api_key=IHR_API_SCHLUESSEL
- Hole 10 Aufsteiger-Podcasts (RSS-Feeds) vom Typ Video im OPML-Format http://api.podcast.de/api/charts/climber/?channel_type=VIDEO&format=OPML&limit=10&api_key=IHR_API_SCHLUESSEL
- Hole 25 Aufsteiger-Podcasts (RSS-Feeds) von beliebigem Typ ab Startposition 10 im RSS-Format http://api.podcast.de/api/charts/climber/?channel_type=ALL&format=RSS&limit=25&start_index=10&api_key=IHR_API_SCHLUESSEL
api/charts/newcomer/
Es wird eine Liste von Podcasts (RSS-Feeds) zurückgeliefert. Die Sortierung erfolgt nach einem geheimen Algorithmus. Das Ergebnis entspricht den Neueinsteigern bei den Charts der Webseite.
URL
http://api.podcast.de/api/charts/newcomer/
Formate
XML, RSS, OPML
HTTP Methode(n)
GET
Parameter
- api_key
- Pflicht. Siehe Authentifizierung.
- format
- Optional. Default ist XML. Gültige Werte: Siehe Formate.
- start_index
- Optional. Default ist 0. Gültige Werte: Positiver Integer.
- limit
- Optional. Default ist 100. Gültige Werte: Positiver Integer.
- channel_type
- Optional. Default is AUDIO. Gültige Werte: AUDIO, VIDEO, ALL.
Beispiele
- Hole Liste von Neueinsteiger-Podcasts (RSS-Feeds) vom Typ Audio im XML-Format http://api.podcast.de/api/charts/newcomer/?api_key=IHR_API_SCHLUESSEL
- Hole 10 Neueinsteiger-Podcasts (RSS-Feeds) vom Typ Video im OPML-Format http://api.podcast.de/api/charts/newcomer/?channel_type=VIDEO&format=OPML&limit=10&api_key=IHR_API_SCHLUESSEL
- Hole 25 Neueinsteiger-Podcasts (RSS-Feeds) von beliebigem Typ ab Startposition 10 im JSON-Format http://api.podcast.de/api/charts/newcomer/?channel_type=ALL&format=JSON&limit=25&start_index=10&api_key=IHR_API_SCHLUESSEL
api/charts/subscriber/
Es wird eine Liste von Podcasts (RSS-Feeds) sortiert nach der Anzahl der Abonnenten zurückgeliefert. Das Ergebnis entspricht den Abonnenten-Charts der Webseite.
URL
http://api.podcast.de/api/charts/subscriber/
Formate
XML, JSON, OPML
HTTP Methode(n)
GET
Parameter
- api_key
- Pflicht. Siehe Authentifizierung.
- format
- Optional. Default ist XML. Gültige Werte: Siehe Formate.
- start_index
- Optional. Default ist 0. Gültige Werte: Positiver Integer.
- limit
- Optional. Default ist 100. Gültige Werte: Positiver Integer.
- channel_type
- Optional. Default is AUDIO. Gültige Werte: AUDIO, VIDEO, ALL.
Beispiele
- Hole Liste von Podcasts (RSS-Feeds) aus den Abonnenten-Charts vom Typ Audio im XML-Format http://api.podcast.de/api/charts/subscriber/?api_key=IHR_API_SCHLUESSEL
- Hole 10 Podcasts (RSS-Feeds) aus den Abonnenten-Charts vom Typ Video im OPML-Format http://api.podcast.de/api/charts/subscriber/?channel_type=VIDEO&format=OPML&limit=10&api_key=IHR_API_SCHLUESSEL
- Hole 25 Podcasts (RSS-Feeds) aus den Abonnenten-Charts von beliebigem Typ ab Startposition 10 im JSON-Format http://api.podcast.de/api/charts/subscriber/?channel_type=ALL&format=JSON&limit=25&start_index=10&api_key=IHR_API_SCHLUESSEL
api/search/
Eine Anfrage liefert eine Liste von Podcasts (RSS-Feeds) im gewünschten Format zurück. Die Sortierung erfolgt nach Relevanz.
URL
http://api.podcast.de/api/search/
Formate
XML, JSON, OPML, RSS
HTTP Methode(n)
GET
Parameter
- api_key
- Pflicht. Siehe Authentifizierung.
- q
- Pflicht. URL-enkodierter Suchbegriff.
- format
- Optional. Default ist XML. Gültige Werte: Siehe Formate.
- start_index
- Optional. Default ist 0. Gültige Werte: Positiver Integer.
- limit
- Optional. Default ist 100. Gültige Werte: Positiver Integer. Die Anzahl der Ergebnisse wird serverseitig auf 200 begrenzt.
- channel_type
- Optional. Default is AUDIO. Gültige Werte: AUDIO, VIDEO, ALL.
Beispiele
- Hole eine Liste von Audio-Podcasts (RSS-Feeds) zum Thema "Berlin" im XML-Format http://api.podcast.de/api/search/?q=Berlin&api_key=IHR_API_SCHLUESSEL
- Hole 5 Video-Podcasts (RSS-Feeds) als OPML-Liste zum Thema Internet http://api.podcast.de/api/search/?q=Internet&format=OPML&channel_type=VIDEO&limit=5&api_key=IHR_API_SCHLUESSEL
- Hole 25 Podcasts (RSS-Feeds) von beliebigem Typ zum Thema Programmierung im JSON-Format ab Position 75 http://api.podcast.de/api/search/?q=Programmierung&format=JSON&channel_type=ALL&limit=25&start_index=75&api_key=IHR_API_SCHLUESSEL
api/subscription/track/
Mit dieser Methode können die Aktivitäten im Bereich der Abonnements im System des API-Benutzers an podcast.de gemeldet werden. Das Hinzufügen und Löschen von RSS-Feeds als Abo wird getrackt. Die anonymen Daten werden zur Berechnung der Charts bei podcast.de herangezogen.
URL
http://api.podcast.de/api/subscription/track/
Formate
xml, json
HTTP Methode(n)
POST
Parameter
- url
- Pflicht. URL-enkodierte Adresse des RSS-Feeds.
- event
- Optional. Default ist ADD. Mögliche Werte sind ADD, DELETE.
Beispiele
- Ein neues Abonnement des Tagesschau Audio-Podcast eines Benutzers soll gemeldet werden. http://api.podcast.de/api/subscription/track/?url=http%3A%2F%2Fwww.tagesschau.de%2Fexport%2Fpodcast%2Ftagesschau%2F&api_key=IHR_API_SCHLUESSEL
- Ein Benutzer hat den Video-Podcast ZDF direkt aus seinen Abonnements gelöscht. http://api.podcast.de/api/subscription/track/?url=&event=DELETE&api_key=IHR_API_SCHLUESSEL