OTS API Dokumentation
Das Application Programmer Interface (API) von APA-OTS ist ein REST Webservice, das zum strukturierten Auslesen von OTS-Inhalten (alle Presseaussendungen und Anhänge seit 1999) benutzt werden kann.
Die Verwendung ist kostenfrei, einzige Bedingung ist die Anforderung eines API-Schlüssels und das Akzeptieren der Nutzungsbedingungen. Zugriffe sind auf 2.500 Requests pro API-Schlüssel pro Tag beschränkt, bei höheren Anforderungen empfiehlt sich die Verwendung von Caching-Mechanismen bzw. kontaktieren Sie uns bitte über das Kontaktformular zum Treffen gesonderter Vereinbarungen.
Zugriffspunkt:
https://www.ots.at/api/
Funktionen
Die API bietet zwei verschiedene Funktionen an. Es können mehrer Aussendungen mit einer Abfrage als Liste dargestellt werden, oder eine einzelne Aussendung unter Angabe ihres OTS-Schlüssels.
Liste
Gibt mehrere OTS-Aussendungen zurück.
Zugriffspunkt:
https://www.ots.at/api/liste
| Parameter | Verpflichtend | Beschreibung |
| app | ja | Api-Schlüssel zur Authentifizierung |
| query | ja | Suchabfrage z.B. „Faymann“ oder „FPÖ“ (auch komplexe Abfragen nach Aussender, Ressort oä möglich) |
| anz | nein | Anzahl der auszugebenden Ergebnisse (mind. , standard , max. ) |
| page | nein | Nummer der Ergebnisseite. Bei zb anz=10 und page=2 werden Ergebnisse 11-20 zurückgeliefert |
| von | nein | Timestamp ab dem Ergebnisse angezeigt werden sollen (Unix Timestamp in Sekunden) |
| bis | nein | Timestamp bis zu dem Ergebnisse angezeigt werden sollen (Unix Timestamp in Sekunden) |
| felder | nein | Mit Space getrennte, auszugebende Felder. Wenn nicht angegeben wird Grundauswahl angezeigt |
| format | nein | Definition des Ausgabeformats. Mögliche Formate sind: |
| callback | nein | Name der Callback-Funktion (jsonp) |
| markup | nein | Soll Umwandlung des Inhalts in HTML (Absätze, Zwischentitel, Listen) durchgeführt werden? Standard: |
| sourcetype | nein | Filtermöglichkeit für Aussendungs-Quellen. Mögliche Werte: OTS (nur OTS-Aussendungen, ist Standard) OTM (nur MediaContact-Plus E-Mail-Aussendungen)
ALL (alle Aussendungs-Quellen) |
mögliche Felder für Aussendungen:
|
mögliche Felder für Anhänge:
|
Die Parameter werden als Key-Value Paar an die URL angehängt.
https://www.ots.at/api/liste?app=yourAppId&query=Heinz%20Fischer&anz=3&von=1356994801
Sobald die Parameter Sonderzeichen enthalten ist es ratsam die URL zu codieren, sodass sich nur URL-sichere Zeichen darin befinden.
Ausgabe
Wenn nicht anders angegeben werden folgende Felder ausgegeben:
Beispieloutput in json
[{
„TITEL“:“AVISO an die Redaktionen – Live-\u00dcbertragung der Sitzung des Bundesrats am 6. Juni“,
„UTL“:“Topthema auf www.ots.at“,
„DATUM“:“2013-05-31″,
„ZEIT“:“12:18:08″,
„ZEITSTEMPEL“:“1369995488″,
„EMITTENT“:“APA-OTS Originaltext-Service GmbH“,
„WEBLINK“:“https:\/\/www.ots.at\/presseaussendung\/OTS_20130531_OTS0149\/aviso-an-die-redaktionen-live-uebertragung-der-sitzung-des-bundesrats-am-6-juni“
},
{
„TITEL“:“PR-Bild-Award 2013: APA-OTS sucht die besten PR-Bilder des Jahres“,
„UTL“:“Einreichfrist endet am 14. Juni – Sonderkategorie \“Tourismus\n und Freizeit\““,
„DATUM“:“2013-05-06″,
„ZEIT“:“12:53:04″,
„ZEITSTEMPEL“:“1367837584″,
„EMITTENT“:“APA-OTS Originaltext-Service GmbH“,
„WEBLINK“:“https:\/\/www.ots.at\/presseaussendung\/OTS_20130506_OTS0136\/pr-bild-award-2013-apa-ots-sucht-die-besten-pr-bilder-des-jahres“
}]
„TITEL“:“AVISO an die Redaktionen – Live-\u00dcbertragung der Sitzung des Bundesrats am 6. Juni“,
„UTL“:“Topthema auf www.ots.at“,
„DATUM“:“2013-05-31″,
„ZEIT“:“12:18:08″,
„ZEITSTEMPEL“:“1369995488″,
„EMITTENT“:“APA-OTS Originaltext-Service GmbH“,
„WEBLINK“:“https:\/\/www.ots.at\/presseaussendung\/OTS_20130531_OTS0149\/aviso-an-die-redaktionen-live-uebertragung-der-sitzung-des-bundesrats-am-6-juni“
},
{
„TITEL“:“PR-Bild-Award 2013: APA-OTS sucht die besten PR-Bilder des Jahres“,
„UTL“:“Einreichfrist endet am 14. Juni – Sonderkategorie \“Tourismus\n und Freizeit\““,
„DATUM“:“2013-05-06″,
„ZEIT“:“12:53:04″,
„ZEITSTEMPEL“:“1367837584″,
„EMITTENT“:“APA-OTS Originaltext-Service GmbH“,
„WEBLINK“:“https:\/\/www.ots.at\/presseaussendung\/OTS_20130506_OTS0136\/pr-bild-award-2013-apa-ots-sucht-die-besten-pr-bilder-des-jahres“
}]
Aussendung
Gibt den Inhalt einer durch Schlüssel abgefragten Aussendung zurück
Zugriffspunkt:
https://www.ots.at/api/aussendung
| Parameter | Verpflichtend | Beschreibung |
| app | ja | Api-Schlüssel zur Authentifizierung |
| schluessel | ja | Schlüssel der gewünschten OTS-Aussendung z.B. OTS_20130101_OTS0001 |
| felder | nein | Mit Space getrennte, auszugebende Felder. Wenn nicht angegeben wird Grundauswahl angezeigt |
| format | nein | Definition des Ausgabeformats. Mögliche Formate sind: |
| callback | nein | Name der Callback-Funktion (jsonp) |
| markup | nein | Soll Umwandlung des Inhalts in HTML (Absätze, Zwischentitel, Listen) durchgeführt werden? Standard: |
Die Parameter werden als Key-Value Paar an die URL angehängt.
https://www.ots.at/api/aussendung?app=yourAppId&schluessel=OTS_20130506_OTS0136
Sobald die Parameter Sonderzeichen enthalten ist es ratsam die URL zu codieren, sodass sich nur URL-sichere Zeichen darin befinden.
Ausgabe
Wenn nicht anders angegeben werden folgende Felder ausgegeben:
- ACTIONBUTTONS (nur bei MCP)
Beispieloutput in json
{
„TITEL“:“APA baut Fortbildungsschiene f\u00fcr Kommunikation und Medien aus – BILD“,“UTL“:“Top-Themen und Top-Referenten im neuen APA-Campus –
Chefredakteur Michael Lang: \“Qualit\u00e4t unterscheidet\““,“INHALT“:“Wien (OTS) – Unter dem Namen APA-Campus lanciert die \u00f6sterreichische
Nachrichtenagentur ein erweitertes Fort- und Weiterbildungsprogramm
f\u00fcr Menschen in PR und Informationsberufen. Die Kenntnis der Branche
und das Wissen um die Bed\u00fcrfnisse von Journalistinnen und
Journalisten erm\u00f6glichen es der APA, ihr Know-how anwendergerecht und
praxisnah zu vermitteln.Das Kursangebot umfasst etwa 15 Spezialthemen und reicht von
klassischen Schreibwerkst\u00e4tten \u00fcber Fotografenworkshops und
Interviewtrainings, Projektmanagement-Seminaren bis zu
Urheberrechtsbriefings, Markenf\u00fchrungsthemen und vielen mehr. Die
Themenspange richtet sich nach dem Bedarf des Marktes, wird laufend
erweitert und l\u00e4sst auch Individualangebote f\u00fcr Unternehmen zu.Die seit 1999 bestehende und sehr erfolgreiche
Weiterbildungsschiene OTS-Campus, die seither mehr als 280 Workshops
mit etwa 2.250 Teilnehmerinnen und Teilnehmern verzeichnete, bildet
einen Teil des Programms und verschmilzt k\u00fcnftig mit der Marke
APA-Campus.Zur theoretischen und betont praktischen Wissensvermittlung
arbeitet APA-Campus mit leitenden Redakteurinnen und Redakteuren aus
dem eigenen Haus, aber auch mit externen Social Media-Profis,
Wissenschaftern, Medien- und Rechtsexperten zusammen – darunter u.a.
die Interview-Expertin der Kronen Zeitung, Conny Bischofberger, der
Investigativ-Journalist und Falter-Chefredakteur Florian Klenk oder
der Diplomsoziologe und Politikwissenschafter Klaus Eck.Der Ausbau des APA-Fortbildungsangebotes ist laut Chefredakteur
Michael Lang ein logischer Schritt. Professionalit\u00e4t und m\u00f6glichst
hohe Qualifizierung sieht er als \“zwei von wenigen Faktoren, die wir
der heutigen Ressourcen- und Zeitknappheit entgegensetzen k\u00f6nnen –
das gilt f\u00fcr den Einzelnen ebenso wie f\u00fcr die gesamte Branche\“, sagt
Lang und erg\u00e4nzt: \“Es ist letztlich ja auch viel spannender, mit
Menschen zu arbeiten, die ihr Handwerk kompetent beherrschen.\“Die Marke APA-Campus pr\u00e4sentiert sich urban, modern, innovativ,
aufgeweckt und richtet sich an Menschen, die sich im Zentrum des
Geschehens sehen. Das r\u00e4umliche Umfeld bietet die APA-Zentrale am
Wiener Naschmarkt. \“Wohlf\u00fchlen, lernen, netzwerken und dabei Spa\u00df
haben – das sind die Rahmenbedingungen, unter denen wir unsere
Trainings gestalten\“, sagt Karin Thiller, Gesch\u00e4ftsf\u00fchrerin von
APA-OTS und verantwortlich f\u00fcr APA-Campus. \“Die Teilnehmerinnen und
Teilnehmer verlassen uns mit dem Gef\u00fchl, viel mitzunehmen und einen
angenehmen Tag unter Gleichgesinnten verbracht zu haben.\“Weitere Informationen zu den Terminen, den Inhalten, den
Referentinnen und Referenten sind unter www.apa-campus.at abrufbar.
Ausk\u00fcnfte, Informationen und Anmeldungen: Christa Gruber, Andrea
Puslednik, Tel.: +43 1 36060 5313, Fax: +43 1 36060 5399, E-Mail:
campus@apa.atBild(er) zu dieser Aussendung finden Sie im AOM \/ Originalbild-Service
sowie im OTS-Bildarchiv unter https:\/\/bild.ots.at“,“RUECKFRAGEHINWEIS“:“APA – Austria Presse Agentur
Barbara Rauchwarter
Unternehmenssprecherin, Leiterin Marketing & Kommunikation
Tel.: +43\/1\/360 60-5700
mailto:barbara.rauchwarter@apa.at
www.apa.at“,“DATUM“:“2013-04-29″,
„ZEIT“:“10:24:23″,
„ZEITSTEMPEL“:“1367223863″,
„EMITTENT“:“APA-OTS Originaltext-Service GmbH“,
„ANHANG“:[
{
„TITEL“:“APA baut Fortbildungsschiene f\u00fcr Kommunikation und Medien aus „,
„VORSCHAU“:{
„thumb“:“https:\/\/www.ots.at\/anhang\/OBS_20130429_OBS0007.preview_medium_final-0.jpg“,
„full“:“https:\/\/www.ots.at\/anhang\/OBS_20130429_OBS0007.jpg“
},
„CREDIT“:“APA\/Pauty“
}],
„WEBLINK“:“https:\/\/www.ots.at\/presseaussendung\/OTS_20130429_OTS0063\/apa-baut-fortbildungsschiene-fuer-kommunikation-und-medien-aus-bild“
}
„TITEL“:“APA baut Fortbildungsschiene f\u00fcr Kommunikation und Medien aus – BILD“,“UTL“:“Top-Themen und Top-Referenten im neuen APA-Campus –
Chefredakteur Michael Lang: \“Qualit\u00e4t unterscheidet\““,“INHALT“:“Wien (OTS) – Unter dem Namen APA-Campus lanciert die \u00f6sterreichische
Nachrichtenagentur ein erweitertes Fort- und Weiterbildungsprogramm
f\u00fcr Menschen in PR und Informationsberufen. Die Kenntnis der Branche
und das Wissen um die Bed\u00fcrfnisse von Journalistinnen und
Journalisten erm\u00f6glichen es der APA, ihr Know-how anwendergerecht und
praxisnah zu vermitteln.Das Kursangebot umfasst etwa 15 Spezialthemen und reicht von
klassischen Schreibwerkst\u00e4tten \u00fcber Fotografenworkshops und
Interviewtrainings, Projektmanagement-Seminaren bis zu
Urheberrechtsbriefings, Markenf\u00fchrungsthemen und vielen mehr. Die
Themenspange richtet sich nach dem Bedarf des Marktes, wird laufend
erweitert und l\u00e4sst auch Individualangebote f\u00fcr Unternehmen zu.Die seit 1999 bestehende und sehr erfolgreiche
Weiterbildungsschiene OTS-Campus, die seither mehr als 280 Workshops
mit etwa 2.250 Teilnehmerinnen und Teilnehmern verzeichnete, bildet
einen Teil des Programms und verschmilzt k\u00fcnftig mit der Marke
APA-Campus.Zur theoretischen und betont praktischen Wissensvermittlung
arbeitet APA-Campus mit leitenden Redakteurinnen und Redakteuren aus
dem eigenen Haus, aber auch mit externen Social Media-Profis,
Wissenschaftern, Medien- und Rechtsexperten zusammen – darunter u.a.
die Interview-Expertin der Kronen Zeitung, Conny Bischofberger, der
Investigativ-Journalist und Falter-Chefredakteur Florian Klenk oder
der Diplomsoziologe und Politikwissenschafter Klaus Eck.Der Ausbau des APA-Fortbildungsangebotes ist laut Chefredakteur
Michael Lang ein logischer Schritt. Professionalit\u00e4t und m\u00f6glichst
hohe Qualifizierung sieht er als \“zwei von wenigen Faktoren, die wir
der heutigen Ressourcen- und Zeitknappheit entgegensetzen k\u00f6nnen –
das gilt f\u00fcr den Einzelnen ebenso wie f\u00fcr die gesamte Branche\“, sagt
Lang und erg\u00e4nzt: \“Es ist letztlich ja auch viel spannender, mit
Menschen zu arbeiten, die ihr Handwerk kompetent beherrschen.\“Die Marke APA-Campus pr\u00e4sentiert sich urban, modern, innovativ,
aufgeweckt und richtet sich an Menschen, die sich im Zentrum des
Geschehens sehen. Das r\u00e4umliche Umfeld bietet die APA-Zentrale am
Wiener Naschmarkt. \“Wohlf\u00fchlen, lernen, netzwerken und dabei Spa\u00df
haben – das sind die Rahmenbedingungen, unter denen wir unsere
Trainings gestalten\“, sagt Karin Thiller, Gesch\u00e4ftsf\u00fchrerin von
APA-OTS und verantwortlich f\u00fcr APA-Campus. \“Die Teilnehmerinnen und
Teilnehmer verlassen uns mit dem Gef\u00fchl, viel mitzunehmen und einen
angenehmen Tag unter Gleichgesinnten verbracht zu haben.\“Weitere Informationen zu den Terminen, den Inhalten, den
Referentinnen und Referenten sind unter www.apa-campus.at abrufbar.
Ausk\u00fcnfte, Informationen und Anmeldungen: Christa Gruber, Andrea
Puslednik, Tel.: +43 1 36060 5313, Fax: +43 1 36060 5399, E-Mail:
campus@apa.atBild(er) zu dieser Aussendung finden Sie im AOM \/ Originalbild-Service
sowie im OTS-Bildarchiv unter https:\/\/bild.ots.at“,“RUECKFRAGEHINWEIS“:“APA – Austria Presse Agentur
Barbara Rauchwarter
Unternehmenssprecherin, Leiterin Marketing & Kommunikation
Tel.: +43\/1\/360 60-5700
mailto:barbara.rauchwarter@apa.at
www.apa.at“,“DATUM“:“2013-04-29″,
„ZEIT“:“10:24:23″,
„ZEITSTEMPEL“:“1367223863″,
„EMITTENT“:“APA-OTS Originaltext-Service GmbH“,
„ANHANG“:[
{
„TITEL“:“APA baut Fortbildungsschiene f\u00fcr Kommunikation und Medien aus „,
„VORSCHAU“:{
„thumb“:“https:\/\/www.ots.at\/anhang\/OBS_20130429_OBS0007.preview_medium_final-0.jpg“,
„full“:“https:\/\/www.ots.at\/anhang\/OBS_20130429_OBS0007.jpg“
},
„CREDIT“:“APA\/Pauty“
}],
„WEBLINK“:“https:\/\/www.ots.at\/presseaussendung\/OTS_20130429_OTS0063\/apa-baut-fortbildungsschiene-fuer-kommunikation-und-medien-aus-bild“
}
Fehlermeldungen
Fehlermeldungen erhalten Sie wenn:
- Nicht alle Pflichtparameter ausgefüllt sind
- Parameter unerlaubte Werte enthalten
- Die Authentifizierung nicht geklappt hat
Sobald eine Fehlermeldung auftritt werden keine Ergebnisse mehr angezeigt.
Alle Fehlermeldungen beginnen mit „Error:“ und enthalten dann eine genauere Spezifikation des Problems.
{„error“:“Error: General Auth Error“}
| Fehlermeldung | Bedeutung |
|---|---|
| General Auth Error | Der Parameter app enthält keine oder eine ungültige AppId |
| App not active | Die angegebene AppId ist nicht für die Verwendung freigeschaltet |
| General Functions Error / Parameter Function missing |
Die Auswahl der Funktion (liste/aussendung) ist nicht korrekt |
| Required Parameter ‚x‘ missing | Der Pflichtparameter x wurde nicht angegeben |
| Output Format not possible/ Problem bei der Ausgabe |
Die Angabe des Ausgabeformat ist nicht korrekt. Mögliche Formate sind: json, dump |
Behandlung von zu Löschenden Inhalten bei permanenter Speicherung von OTS-Content
Bei permanenter Speicherung von OTS-Inhalten verpflichten sich die Nutzungsberechtigen zur regelmäßigen Kontrolle, ob Inhalte gelöscht werden müssen.
Die zu löschenden Inhalte können tagesaktuell als JSON-Feed unter https://www.ots.at/deleted_ots/ abgerufen werden.
Der Feed enthält den jeweiligen Schlüssel und das Löschdatum aller zu löschenden OTS-Inhalte.