Helpdesk:News in Website
Letzter Autor: induux Redaktion
Vorteile der induux News-Integration
Die in induux eingestellten News können in andere Web-Systeme, wie z. B. die eigene Homepage integriert werden. Das hat einige Vorteile:
- Einmaliges einpflegen ins induux-Profil: Mehrfache Verteilung des Contents. Die News werden einerseits automatisch auf relevanten Kanälen verteilt (siehe https://www.induux.de/distribution/) und andererseits können die News auf der eigenen Website eingebunden werden. So entsteht kein mehrfacher Aufwand. Auf Eurer Website könnt Ihr die Darstellung der News individuell anpassen und mit Eurem Layout versehen.
- Bilder werden auf Webseiten oft zu groß dargestellt und haben eine zu große Dateigröße. Die Daten, die über die News Integration bei Euch auf der Website ausgespielt werden, werden vom induux-Server automatisch optimiert. Das heißt, dass die Bilder komprimiert und für die Suchmaschine optimiert sind.
Die Verwendung der News-Integration ist Teil des induux Premium Profils, siehe https://www.induux.de/account/.
Die News API
Folgend wird die Integration der induux News anhand der News im Profil von induux selber erläutert.
URL: https://ixstuttgartapi.induux.com/news/api/
HTTP Methode: GET
Return Codes:
| Return Code | Beschreibung |
| 200 | OK. Abfrage konnte korrekt bearbeitet werden. |
| 400 | Invalid Request, ein oder meherere Parameter ist/sind falsch. |
| 401 | Authentication required -> API Key ist falsch oder fehlt |
| 404 | Ressource not found. Keine Daten zu gegebener Profile ID gefunden. |
| 405 | Method not allowed. Es wurde eine Andere als GET verwendet. |
| 500 | Internal Server Error. Abfrage konnte aufgund eines Fehlers nicht bearbeitet werden. |
Perameter:
| Parameter | Definition | Default | Beschreibung | Beispiel |
| apiKey | String | null (keier) | Ein Api Key, um sich bei der API zu authentifizieren. | apiKey=dr9k48jf9sdl00kfr |
| id | String oder int | "all" | Profile ID (int), nach der gefiltert werden soll, oder "all" (string) für alle Profile. | id=478 |
| format | String | "json" | Ausgabeformat. Web Feed: rss, atom, json-feed oder REST API: json . | format=atom |
| cat | String | "all" | Kategorie, nach der gefiltert werden soll. Auswahl: all, press, blog | cat=blog |
| from | Date ISO 8601 | letztes halbes Jahr | News erst ab angegebenem Datum ausgeben | from=2020-05-18 |
| to | Date ISO 8601 | letztes halbes Jahr | News nur bis angegebenem Datum ausgeben. | to=2020-05-18 |
| limit | String oder int | all | Anzahl der News in ausgabe auf Wert limitieren. String all für alle, oder ein Wert (int) | limit=10 |
| offset | int | 10 | Offset, ab dem die News ausgegeben werden. Nur mit limit zusammen. Ermöglicht, die news Seitenweise auszugeben. | offset=20 |
| imgw | int | 1000 | Bildgrösse horizontal, für Artikelbilder Urls | imgw=1280 |
| imgh | int | 1000 | Bildgrösse vertikal, für Artikelbiler Urls | imgh=900 |
| killhashtag | boolean | true | Entfernt Hashtags (#) aus Titeln. Bsp '#Sensoren' wird zu 'Sensoren' | killhashtag=false |
Ausgabeformate
- REST API json
- Dieses Ausgabeformat erlaubt es, die Ausgabe noch weiter zu steuern. Die Kombination der Parameter from, to, limit und offst, oder aber auch nur limit und offset
- ermöglichen eine Seitenweise ausgabe, um die Anzahl der News besser auf die gewünschte Integration zuzuschneiden. Daher ist in der JSON Ausgabe ein Meta Datenobjekt, mit : Angabe der Anzahl, des aktuellen limits, des offsets, des offsets der nächsten Seite, bzw. der vorigen Seite und die Datums Begrenzungen, sowie ein Objekt mit den Nutzdaten, welche eine Liste ist mit Item Objekten, wie sie für den JSON-Feed spezifiziert sind.
Die Parameter lassen sich beliebig miteinander kombinieren, um die Auswahl einzuschränken.
Beispiele
- Alle News des induux Profiles (478) anzeigen:
GET Request auf: https://ixstuttgartapi.induux.com/news/api/?apiKey=induuxDemoApiKey&id=478
Die Responses sehen etwa so aus:
{"meta":
{"feedtitle":"induux international gmbh",
"category":"all",
"from":null,
"to":null,
"limit":null,
"offset":null,
"offsetNext":0,
"offsetPrev":0,
"count":15,
"status":"success"
},
"data":[
{"title":"SEOAudit - Die Basis für B2B OnlineReichweite",
"id":"https://de.induux.com/blog/seoaudit-basis-b2b-onlinereichweite-5425",
"link":"https://de.induux.com/blog/seoaudit-basis-b2b-onlinereichweite-5425",
"description":"Unser CEO und #SEO-Experte Veikko Wünsche gibt im Blogartikel des bvik Einblicke,
wie Firmen SEO falsch umsetzen und warum der SEO-Audit die Basis für B2B-Online-Reichweite ist",
"content":"Ihr denkt, ihr macht schon genügend SEO? Unser SEO-Experte und CEO Veikko Wünsche ist da anderer Meinung. Um eine Website ideal zu führen, zu konzipieren
und umzusetzen, ist das Zusammenspiel verschiedener Spezialbereiche notwendig.Im Gastbeitrag im Blog des Bundesverband Industrie Kommunikation e.V.
(bvik) zeigt Veikko, worauf es beim SEO Audit wirklich ankommt.Er weiß: wieso man ohne SEO Audit keine Top-Rankings
erzielt. wann die beste Zeit für den SEO Audit ist, wie ein SEO Audit aufgebaut sein muss, dass ein SEO Audit weniger kostet
als gedacht, wie der SEO Audit gelingt, Den ganzen Beitrag lest Ihr im bvik-Blog.",
"date":"2019-11-20T13:43:00.000Z",
"image":"https://img.induux.de/news/5425.jpg?h=1000&w=1000"
}, { ... }
]
}
- Alle Presseartikel des induux Profiles (478) anzeigen:
GET Request auf: https://ixstuttgartapi.induux.com/news/api/?apiKey=induuxDemoApiKey&id=478&cat=press
- Alle Presseartikel des induux Profiles (478) anzeigen, die vor dem 01.01.2019 veröffentlicht wurden:
GET Request auf: https://ixstuttgartapi.induux.com/news/api/?apiKey=induuxDemoApiKey&id=478&cat=press&to=2019-01-01
- Die ersten 10 aller news Artikel des induux Profiles anzeigen:
GET Request auf: https://ixstuttgartapi.induux.com/news/api/?apiKey=induuxDemoApiKey&id=478&limit=10&offset=0
- Die nächsten 10 aller news Artikel des induux Profiles anzeigen:
GET Request auf: https://ixstuttgartapi.induux.com/news/api/?apiKey=induuxDemoApiKey&id=478&limit=10&offset=10
- Die Bildgröße für die Artikelbilder lässt sich mit den imgw / imgh Parametern einstellen./
GET Request auf: https://ixstuttgartapi.induux.com/news/api/?apiKey=induuxDemoApiKey&id=478&limit=1&offset=10&imgw=1280&imgh=900
Dadurch werden die Bilder Urls von
{ ...
"image": "https://img.induux.de/news/68.jpg?h=1000&w=1000&fit=fill&fill=solid&auto=format",
...
}
zu
{ ...
"image": "https://img.induux.de/news/68.jpg?h=900&w=1280&fit=fill&fill=solid&auto=format",
...
}
verändert. Dies bewirkt, dass das Bild gleich in der richtigen (benötigten) Größe ausgeliefert wird.
News Feed
Neben einer Rest API gibt es auch noch die klassischen News Feeds im Format RSS, Atom und JSON. Die Parameter der News API (siehe oben) gelten hier auch.
Url: https://ixstuttgartapi.induux.com/news/feed/{rss,atom,json}
Als Beispiel wollen wir einen RSS Feed für alle induux News (Profile ID 478) haben:
| Fromat | Bsp URL |
| RSS 2.0 | https://ixstuttgartapi.induux.com/news/feed/rss?apiKey=induuxDemoApiKey&id=478 |
| Atom | https://ixstuttgartapi.induux.com/news/feed/atom?apiKey=induuxDemoApiKey&id=478 |
| JSON | https://ixstuttgartapi.induux.com/news/feed/json?apiKey=induuxDemoApiKey&id=478 |
Entsprechend wie oben kann man auch die Filter Parameter from und to, sowie die limits und offsets setzeen.
Bsp: https://ixstuttgartapi.induux.com/news/feed/rss?apiKey=induuxDemoApiKey&id=478&limit=1&offset=10&imgw=1280&imgh=900
Ausgabeformate
- Web Feed
- Mit den Ausgabeformaten rss, atom und json-feed erhählt man nach den jeweiligen Spezifikationen einen RSS-Feed, einen Atom-Feed oder einen JSON-Feed. Diese werden von den gängigen RSS-News-Readern korrekt ausgegeben.
Integration in CMS-Systeme
Die News lassen sich in CMS Systeme integrieren, die entwede eine Rest API direkt bzw über Plugins unterstützen. Beispiele hierfür sind WordPress Website erstellen, TYPO3, Drupal, Joomla! .
Integration in Wordpress
WebThinker
Die Firma WebThinker unterstützt Sie bei der Integration der induux News in Wordpress
Notwendigkeit
Mit induux spart Ihr Zeit! In induux eingestellte Presse- oder Blog-Artikel können über eine Web-Schnittstelle automatisch in Eure Website und Euer Layout gezogen werden. Das halbiert den Aufwand und es bleibt mehr Zeit für andere Aufgaben. Zudem wird dabei das Artikel-Bild vollautomatisch optimiert (Skalierung, WebP-Format ...).