Transportverfahren | Übertragung per Restful API (https) |
|---|---|
Objekt | Artikel, Bilder, NGEN-ID |
Trigger | Request durch Drittsystem |
Typische Drittsysteme | Typische Anbindungen sind Drittsysteme zur Content-Erstellung für Online |
Beispieldaten | → siehe swagger-Dokumentation |
...
Der aktuelle Funktionsumfang kann über das Swagger User Interface eingesehen werden:
https://mt-master-create-test.peiq.cloud/createapi/createapi.html#/
GET: Abfragen von API Infos
...
limit: max. Anzahl der Artikel, die gesucht werden sollen (optional)
eventName: changed (Pflicht)
offset oder offsetindex: Gibt an, wie viele Artikel in der Ergebnisliste am Anfang übersprungen werden sollen (optional)
...
| Code Block |
|---|
{{baseUrl}}/createapi/v1/articles/{{article_cid}} |
cURL:
| Code Block |
|---|
curl --location --request GET 'https://mt-master-create-test.peiq.cloud/createapi/v1/articles/202-2117130' \ --header 'Authorization: Bearer [TOKEN]' |
...
Es müssen mind. ‘id’und ‘template_name’angegeben werden, damit ein Artikel angelegt wird (type kann weggelassen werden und ist automatisch ‘Main’)
Bei den ‘contents’-Elementen (z. B. Titel, Unterteil, Paragraph usw.) wird geprüft, ob die notwendigen Daten-Strukturen korrekt angegeben wurden. Bei unbekannten contents-Elementen wird eine entsprechende Fehlermeldung ausgegeben.
Wenn CIDs von Clustern übergeben werden, wird geprüft, ob der Cluster (image, lead_image, teaser_image, image_gallery, embed, article_link) auch im System vorhanden ist. Gibt es ein Element/Cluster nicht, wird eine entsprechende Fehlermeldung ausgegeben.
Wenn ein ‘subarticle’ (Infobox, Onlinebox) angegeben wird, muss die ‘variant_id’ angegeben sein und in den Requestdaten muss eine dazu passende variante mit angegeben sein ('variant_id' muss eindeutig sein).
Prüfung Kanal-übergreifender Metadaten (Parametrisierbar)
...
| Include Page | ||||
|---|---|---|---|---|
|
Nur für PEIQ-Mitarbeiter: