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 |
...
Code Block |
---|
{
"offset": "45",
"data": [
{
"id": "202-2117139"
},
{
"id": "202-2110803"
},
{
"id": "202-2117170"
},
{
"id": "202-2117171"
},
{
"id": "202-2117172"
}
]
} |
Status | ||||
---|---|---|---|---|
|
Von einem Drittsystem aus können per CREATE API nach zuletzt geänderten CREATE-Artikel nach dem Kanal aus der Datenbank gefiltert und abgefragt werden. Als Ergebnis wird eine Liste mit IDs ausgegeben.
Mögliche Parameter
Kanal “Online”
Kanal “Print”
Beispiel
Status | ||||
---|---|---|---|---|
|
Code Block |
---|
{{baseUrl}}/createapi/v1/articles/events?eventName=changed&channel=Online |
Response
Code Block |
---|
{
} |
Status | ||||
---|---|---|---|---|
|
Von einem Drittsystem aus können per CREATE API nach zuletzt geänderten CREATE-Artikel nach dem Kanal und Status aus der Datenbank gefiltert und abgefragt werden. Als Ergebnis wird eine Liste mit IDs ausgegeben.
Mögliche Parameter
channel=Online
channel=Print
state=Erfassung
state=Publiziert
state=Revision
Beispiel
Status | ||||
---|---|---|---|---|
|
Code Block |
---|
{{baseUrl}}/createapi/v1/articles/events?eventName=changed&channel=Online&state=Publiziert |
Response
Code Block |
---|
{
} |
GET: Einzelne CREATE-Artikel abfragen
Alternativ kann auch eine feste Artikel-ID als Variable in der Postman Environment hinterlegt werden.
Mögliche Parameter
limit: max. Anzahl der Artikel, die gesucht werden sollen
eventname: changed
offset oder offsetindex: Gibt an, wie viele Artikel in der Ergebnisliste am Anfang übersprungen werden sollen
Beispiel
Status | ||||
---|---|---|---|---|
|
Code Block |
---|
{{baseUrl}}/createapi/v1/articles/{{cid}} |
...
Code Block |
---|
curl --location --request GET 'https://mt-master-create-test.peiq.cloud/createapi/v1/articles/202-2117130' \ --header 'Authorization: Bearer [TOKEN]' |
Response
Als Ergebnis wird die CID des erstellten Artikels ausgegeben.
...
Zum Anlegen eines CREATE-Artikels werden mindestens “id”, “type” und “template_name” in “variants” (Artikel-Ausprägung) benötigt.
Mögliche Parameter
Keine Parameter.
Beispiel
Status | ||||
---|---|---|---|---|
|
...
Code Block |
---|
curl --location --request POST 'https://mt-master-create-test.peiq.cloud/createapi/v1/articles' \ --header 'Authorization: Bearer [TOKEN]' \ --header 'Content-Type: text/plain' \ --data-raw '{ "external_id": "", "keywords": [ { "name": "Wirtschaft", "type": "topic", "priority": 5 }, { "name": "Politik", "type": "topic", "priority": 4 }, { "name": "News", "type": "topic", "priority": 3 } ], "seo": { "title": "SEO Titel", "description": "SEO Beschreibung" }, "variants": [ { "id": "HrlLaqcemUywP-UWtM9mcA", "type": "Main", "template_name": "Story_D", "status": "Erfassung", "channels": [ { "name": "Online", "publish": false, "publish_start": "2022-08-11T00:00:00+00:00", "publish_end": "2022-08-31T00:00:00+00:00", "publish_day": "", "status": "Erfassung", "paid_content": false, "categories": [ { "id": "1-15826189", "paths": [ { "path": "anzeigensonder" } ] } ] }, { "name": "Print", "publish": true, "publish_start": "", "publish_end": "", "publish_day": "2022-08-17", "status": "Fertig", "categories": [ { "id": "", "paths": [ { "path": "ma/anz" } ] } ] } ], "contents": [ { "type": "catchline", "value": { "text": "Das ist die Dachzeile." } }, { "type": "title", "value": { "text": "Das ist der Titel." } }, { "type": "subline", "value": { "text": "Das ist der Untertitel." } }, { "type": "teaser", "value": { "text": "Das ist der Teaser mit <strong>fett</strong>, <em>kursiv</em> und einem <a href=\"https://peiq.de\">Link</a>." } }, { "type": "paragraph", "value": { "text": "Das ist ein Textabsatz mit <strong>fett</strong>, <em>kursiv</em> und einem <a href=\"https://peiq.de\">Link</a>." } }, { "type": "subtitle", "value": { "text": "Das ist ein Zwischentitel." } }, { "type": "question", "value": { "text": "How are you?" } }, { "type": "answer", "value": { "text": "I am fine." } }, { "type": "author", "value": { "text": "Alex API Tester" } }, { "type": "location", "value": { "text": "Bergkirchen" } }, { "type": "source", "value": { "text": "postman" } }, { "type": "quote", "value": { "text": "Phantasie ist wichtiger als Wissen, denn Wissen ist begrenzt.", "source": "Albert Einstein" } }, { "type": "list", "value": [ { "text": "Das ist ein Listeneintrag mit <strong>fett</strong>, <em>kursiv</em> und einem <a href=\"https://peiq.de\">Link</a>." } ] }, { "type": "teaser_image", "value": { "image": { "id": "202-2119498" } } }, { "type": "image", "value": { "image": { "id": "202-2119472" } } }, { "type": "embed", "value": { "id": "202-2118864" } } ] } ] }' |
Response
Als Ergebnis wird die CID des erstellten Artikels ausgegeben.
...
Code Block |
---|
curl --location --request PUT 'https://mt-master-create-test.peiq.cloud/createapi/v1/articles/202-2119506' \ --header 'Authorization: Bearer [TOKEN]' \ --header 'Content-Type: text/plain' \ --data-raw '{ "external_id": "", "variants": [ { "id": "", "type": "", "template_name": "", "status": "", "channels": [ { "name": "Online", "publish": true, "publish_start": "", "publish_end": "", "publish_day": "", "status": "", "paid_content": true, "categories": [ { "id": "", "paths": [ { "path": "" } ] } ] } ], "contents": [ { "type": "catchline", "value": { "text": "Update: Dachzeile." } }, { "type": "title", "value": { "text": "Update: Titel." } }, { "type": "subline", "value": { "text": "Update: Untertitel." } }, { "type": "teaser", "value": { "text": "Update: Teaser mit <strong>fett</strong>, <em>kursiv</em> und einem <a href=\"https://peiq.de\">Link</a>." } }, { "type": "paragraph", "value": { "text": "Update: Textabsatz mit <strong>fett</strong>, <em>kursiv</em> und einem <a href=\"https://peiq.de\">Link</a>." } }, { "type": "subtitle", "value": { "text": "Update: Zwischentitel." } }, { "type": "author", "value": { "text": "" } }, { "type": "location", "value": { "text": "" } }, { "type": "source", "value": { "text": "" } }, { "type": "quote", "value": { "text": "Update Zitat", "source": "Update: Zitatquelle" } }, { "type": "list", "value": [ { "text": "Update: Das ist ein Listeneintrag mit <strong>fett</strong>, <em>kursiv</em> und einem <a href=\"https://peiq.de\">Link</a>." } ] } ] } ] }' |
Response
Als Ergebnis wird die ID des aktualisierten Artikels ausgegeben.
...
Ausführliche Informationen dazu finden sich unter https://peiq.atlassian.net/wiki/spaces/PPSD/pages/915701820/0-21+PEIQ+DAM-API#Suche-nach-bestimmten-Bildern.
Beispiel
Status | ||||
---|---|---|---|---|
|
Code Block |
---|
{baseUrl}/images/202-2119472/HighRes |
Die Metadaten des Bildes können ohne den Zusatz für die Auflösung abgeholt werden.
Beispiel
Status | ||||
---|---|---|---|---|
|
Code Block |
---|
{baseUrl}/images/202-2119472 |
Response
Code Block |
---|
{ "archive_id": null, "caption": "Abraham vs. KhorenGevor ging nach einem linken Haken in der elften Runde zunächst in die Knie und kippte dann benommen hinten über kippte.Arthur Abraham besteigt als König den Ring in der Berliner Max-Schmeling-Halle. Vor 6000 Zuschauern musste er seinen IBF-Gürtel im Mittelgewicht gegen Khoren Gevor verteidigen. Der 28-Jährige Herausforderer kam in den ersten Runden oft zum Schlag, Abraham verhinderte Schlimmeres mit seiner Doppeldeckung. Nur einmal geriet Abraham ins Straucheln. Das lag allerdings mehr daran, dass Gevor ihm beim Angriff ein wenig umgrätschte. Abraham behielt dennoch einen kühlen Kopf und zog seine Taktik unbeeidruckt durch. Nach fünf Runden ließ die Kraft bei beiden ein wenig nach. Während der 27-Jährige Abraham durch passive Boxweise Kraft sammelte, boxte sich Kohen müde zum Ende des Kampfes drehte Abraham wieder auf und landete harte Schläge am Kopfs seines Herausforderers. Am Ende behielt Abraham dank seiner harten Punches die Oberhand gegen Universum-Schützling Gevor, der nach einem linken Haken in der elften Runde zunächst in die Knie ging und dann benommen hinten über kippte. <?ZE?>Der Ringrichter entschied sofort auf Abbruch und technischen Ko. Khoren wurde später aufgrund einer schweren Gehirnerschütterung behandelt.BERLIN - AUGUST 18: Khoren Gevor of Germany lies on the ground after he was knocked out by Arthur Abraham during the IBF World Championship Middleweight fight between Arthur Abraham and Khoren Gevor at the Max Schmeling Halle August 18, 2007 in Berlin, Germany. (Photo by Martin Rose/Bongarts/Getty Images)", "creation_timestamp": "2022-12-07T13:56:48+01:00", "creation_user": "create_tester_01", "filename": "1-15734248", "honorar_id": null, "object": "ta", "edition": null, "origin": "Create", "original_id": "DBild/202-4284773", "id": "202-2119472", "by_line": "Martin Rose", "category": "ku", "location": null, "credit": "Bongarts/Getty Images", "country": null, "date_time_created": null, "object_name": null, "service_identifier": null, "source": null, "special_instructions": null, "title": "Arthur Abraham v Khoren Gevor - IBF Middleweight World Championship", "urgency": null, "status": "Kopie", "underline": "Normales Bold", "image_source": "Bongarts/Getty Images", "image_region": null, "keywords": [ { "name": "berlin", "type": "location", "priority": 4 }, { "name": "germany", "type": "location", "priority": 3 }, { "name": "BOX", "type": "organisation", "priority": 1 }, { "name": "Boxen", "type": "topic", "priority": 5 } ], "modification_timestamp": "2022-12-07T13:57:02+01:00", "modification_user": "create_tester_01", "usage_instructions": null, "width": 696, "height": 464, "sha1": "ihhuu2hdDg7lM389o35Hme5jKh9" } |
...
Include Page | ||||
---|---|---|---|---|
|
Nur für PEIQ-Mitarbeiter: