OTS API Beispiele

Die APA-OTS API ist ein REST Webservice. Dadurch können ganz einfach Parameter übergeben und ein Ergebnis empfangen werden. Viele Frameworks stellen vorgefertigte Schnittstellen für solche Webservices zur Verfügung, aber auch das selbst schreiben der Zugriffsschnittstelle ist leicht möglich.

In PHP kann beispielsweise einfach eine URL mit GET-Parametern erstellt und mittels der Funktionen file_get_contents() oder curl das Ergebnis geholt werden.

Folgende Beispiele sollen den Einsatz der Parameter verdeutlichen:

Szenario: Pressemappe

gewünschter Output:
Liste der letzten 15 Aussendungen einer Firma

Parameter:

• query mit emittentid
• anz

Abfrage zusammenbauen:
Durch ein = in der Query wird angeraten die Query mit urlencode() in URL-sichere Zeichen umzuwandeln.

Szenario: Person

gewünschter Output:
Aussendungen im Mai 2013, in denen der Name Heinz Fischer vorkommt

Parameter:

• query
• von
• bis

Abfrage zusammenbauen:

Szenario: Bilder

gewünschter Output:
alle Bilder aus dem Channel Medien der letzten Wochen

Parameter:

• query
• inhalt
• von

Abfrage zusammenbauen:
Um immer den aktuellsten Zeitraum von einer Woche zu erhalten kann ein negativer Timestamp an den Parameter „von“ übergeben werden, der dann vom aktuellen Timestamp abgezogen wird.

Szenario: Aussendung

gewünschter Output:
eine durch Schlüssel identifizierte OTS-Aussendung

Parameter:

• schluessel

Abfrage zusammenbauen:

Szenario: MediaContact-Plus

gewünschter Output:
Liste der letzten 15 eigenen MediaContact-Plus E-Mail-Aussendungen

Parameter:

• query mit eigener emittentid
• anz
• sourcetype=OTM

Abfrage zusammenbauen:
Durch ein = in der Query wird angeraten die Query mit urlencode() in URL-sichere Zeichen umzuwandeln.