ZINIO Pro NewsML Guidelines

Zinio Pro NewsML
CONFIGURATION GUIDELINES FOR PARTNERS

Ruby Batallones - Version 1.1
13th April, 2017

1 www.ziniopro.com

Table of Contents
● Overview 3
○ NewsML Format 4
○ NewsEnvelope 4
○ NewsIdentifier 5
○ NewsManagement 6
○ NewsComponent 6
○ ContentItem 7
● Using the Zinio NewsML API 9
● How to Fetch All Stories 9
● How to Fetch the Latest Stories 10
● How to Fetch Issues for a Specific Channel 10
● Support 11
● Annex A: Sample NewsML Feed 11

2 www.ziniopro.com

Overview
This document describes Zinio’s NewsML API available for Publishers and Partners.
NewsML is a compact, extensible, and flexible structural framework for news content that
aims to provide a uniform interface regardless of the type of media. Publishers and
Partners get access to their NewsML feed along with their ZinioPro CMS account.
Common questions related to access, pagination, and fetching content are also
addressed in this document. For more information on the NewsML standards, structure,
and datatypes, please refer to the official Functional Specifications documentation here:
https://www.iptc.org/std/NewsML/1.2/specification/NewsML_1.2-spec-functionalspec_9.html

3 www.ziniopro.com

NewsML Format

Zinio’s NewsML feed is compliant with the NewsML 1.2 standard.
The succeeding sections describe the objects, elements, and sub-elements used in the
Zinio NewsML implementation. Field values follow the standard specifications stated in
the official Guidelines documentation at
https://www.iptc.org/std/NewsML/1.2/documentation/NewsML_1.2-doc-Guidelines_1.01.pdf.
Notes are provided here for supplemental information.
Refer to Annex A for a sample of a complete NewsML feed.
NewsEnvelope
The NewsEnvelope contains information on how the NewsML document is used and
exchanged between the provider and receiver.
Properties Sample Data
<NewsEnvelope> <NewsEnvelope>
<DateAndTime> <DateAndTime>20170407T114816Z</DateAndTime>
<NewsService> <NewsService FormalName="Thumbnail" link-url="">
</NewsService>
</NewsEnvelope>
DateAndTime represents the date and time of when the NewsML feed was transmitted.

4 www.ziniopro.com

NewsIdentifier
The NewsIdentifer provides a globally unique identifier for a specific NewsItem.
<Identification> <Identification>
<NewsIdentifier> <NewsIdentifier>
<ProviderId> <ProviderId>ziniopro.com</ProviderId>
<DateId> <DateId>20170330</DateId>
<NewsItemId> <NewsItemId>3056-157-22293</NewsItemId>
<RevisionId> <RevisionId Update="N"
<Public Identifier> PreviousRevision="1">1
<DateLabel> </RevisionId>
<NameLabel> <PublicIdentifier>
<Label> urn:newsml:ziniopro.com:20170330:3056-157-22293:1
<LabelType> </PublicIdentifier>
<LabelText> </NewsIdentifier>
<DateLabel/>
<NameLabel/>
<Label>
<LabelType FormalName="IssueID"/>
<LabelText>157</LabelText>
</Label>
<Label>
<LabelType FormalName="IssueName"/>
<LabelText>Revised_test_20170329</LabelText>
</Label>
<Label>
<LabelType FormalName="IssueISSN"/>
<LabelText/>
</Label>
</Identification>
The DateID represents the date when the NewsItem was first created. This value does
not change even when the NewsItem is revised.
The Label element is used for specific identifiers. Thee IssueID, IssueName, and the
IssueISSN are provided as additional Label identifiers.
5 www.ziniopro.com

NewsManagement
This object provides information about a NewsItem’s type, history, status, relationship to
other NewsItems, as well as additional properties.
<NewsManagement> <NewsManagement>
<NewsItemType> <NewsItemType FormalName="News"/>
<FirstCreated> <FirstCreated>20170330T024416Z</FirstCreated>
<ThisRevisionCreated> <ThisRevisionCreated>20170228T034514Z
<Status> </ThisRevisionCreated>
<Status FormalName="Usable"/>
</NewsManagement>

NewsComponent
The NewsComponent serves as a container for news objects, defines the layout and
structure, and describes news information.
<NewsComponent> <NewsComponent Duid="story_7089">

<NewsLines> <NewsLines>
<HeadLine> <HeadLine>EDITOR’S LETTER</HeadLine>
<DateLine> <DateLine>20170228T034514Z</DateLine>
<Author> <Author>noreply@ziniopro.com</Author>
<CopyrightLine> <CopyrightLine/>
<AdministrativeMetadata> </NewsLines>
<Provider> <AdministrativeMetadata>
<Party> <Provider>
<Creator> <Party FormalName="Audience Media"/>
<Party> </Provider>
<DescriptiveMetadata> <Creator>
<Language> <Party FormalName=""/>
<Property> </Creator>
</AdministrativeMetadata>
<DescriptiveMetadata>
<Language FormalName="eng-GB"/>
<Property FormalName="Issue">
<Property FormalName="Name"
Value="Southern Eats 2017"/>
<Property FormalName="CoverDate"
6 www.ziniopro.com

Value="1487203200"/>
<Property FormalName="ISSN" Value=""/>
<Property FormalName="Section"
Value="IN THIS ISSUE"/>
</Property>
</DescriptiveMetadata>
The Creator property indicates the party that created the NewsItem.

ContentItem
The ContentItem element wraps the content and metadata. It is the representation of a
text body, a digital picture, or an audio or video sample.
<ContentItem> <ContentItem>
<MediaType> <MediaType FormalName="ComplexData"/>
<MimeType> <MimeType FormalName="text/vnd.IPTC.NITF"/>
<Format> <Format FormalName="bcNITF2.5"/>
<Characteristics> <Characteristics>
<Property> <Property FormalName="WordCount"
<DataContent> Value="273"/>
<nitf> </Characteristics>
<body> <DataContent>
<body.head> <nitf>
<body.content> <body>
<body.head>
<headline>EDITORIAL</headline>
</body.head>
<body.content>
<figure>
<img
src="http://site.audiencemedia.com/var/si
te_1036/storage/images/media2/images/f000
6-0113/63377-1-eng-GB/f0006-012.jpg"
alt=""/>
<figcaption/>
</figure>
<div class="">
<div class="image">
<img
src="http://site.audiencemedia.com/var/s
ite_1036/storage/images/media2/images/f0
006-0113/63377-1-eng-GB/f0006-014.jpg"
alt=""/>
<div></div>
</div>
7 www.ziniopro.com

</div>
<p class="pullQuote">
<b>„DER SCHRÄGE“</b>
</p>
<p>
<b>Liebe Leserin, lieber Leser,</b>
es begann mit einem Umzug in eine andere
Stadt.
Um den Abschiedsschmerz meines
</p>
<div class="">
<div class="image">
<img
src="http://site.audiencemedia.com/var/s
ite_1036/storage/images/media2/images/f0
006-0113/63377-1-eng-GB/f0006-012.jpg"
alt=""/>
<div></div>
</div>
</div>
<p class="byline">IHRE BRIGITTE HUBER</p>
</body.content>
</body>
</nitf>
</DataContent>
</ContentItem>

8 www.ziniopro.com

Using the Zinio NewsML API
Retrieve your NewsML feed using the same login information for CMS or through the
partner credentials supplied. For request for new/additional credentials, contact your
Account Manager.
Fetch the feeds using the API endpoint below:
http://sitename.ziniopro.com/api/cms/v1/feed/data/newsml
When retrieving stories, you can opt to retrieve stories from the feed as follows:
/api/cms/v1/feed/data/newsml/:since/:page/:limit/:channel
Where:
:since timestamp value (in Epoch/Unix timestamp format) to get the stories
from a specific time to the current time. 0 specifies the timestamp of
the beginning of the feed.
:page index of the page calculated based on the number of stories fetched
from “:since” timestamp. Default is 1.
:limit the number of the items that should be returned. Default value is 10.
Maximum value is 50.
:channel Optional parameter to fetch the stories of mobile-only or tablet-only
issues. When this is empty, stories for all channels are returned.

How to Fetch All Stories
The current working mechanism of the API does not allow retrieving an infinite amount of
items at once to avoid performance issues when the call might result to a large number
of stories. Clients can use the :page and :limit to retrieve all stories.
9 www.ziniopro.com

Use the parameters below to retrieve page 1 of all stories starting from the latest publish

date to the beginning of the feed. The pages are divided into 50 items per page.
/api/cms/v1/feed/data/newsml/0/1/50
If less than 50 items are returned, that means that the call already retrieved all the stories

and fetching the next page will give an empty response. If 50 items are returned,
increment the page number.
Continue on increasing the page number until you get to the page that returns an empty

result.
How to Fetch the Latest Stories
For example, the publish date of the latest stories is February 28, 2017. Use this tool
(http://www.unixtimestamp.com/index.php) to convert 2017-02-28 00:00:00 to Unix time.
Next, use the Unix time value (1488240000) as the since parameter value. Note that
using the since parameter means that you are fetching the stories from the date range
since time to current time. All stories published after the specified since time will be
returned.
The parameters below will return page 1 of all the published stories from February 28,
2017 to present with a limit of 50 items per page.
How to Fetch Issues for a Specific Channel
The channel parameter is optional. Without specifying a particular channel, the query will
return all available stories for all channels.
To get the stories specific for a channel type, use either tablet, mobile, or web.
The call below will return the mobile-only stories if there are any.
/api/cms/v1/feed/data/newsml/0/1/50/mobile
10 www.ziniopro.com

Support
For inquiries, questions, and request for potential feed customizations, contact
tra.le@zinio.com.

Annex A: Sample NewsML Feed
<NewsML>
<Catalog Href=""/>
<NewsEnvelope>
<DateAndTime>20170410T114042Z</DateAndTime>
<NewsService FormalName="Thumbnail" link-url=""></NewsService>
</NewsEnvelope>
<NewsItem>
<Identification>
<NewsIdentifier>
<ProviderId>audiencemedia.com</ProviderId>
<DateId>20170228</DateId>
<NewsItemId>1036-97-7089</NewsItemId>
<RevisionId Update="N" PreviousRevision="1">1</RevisionId>
<PublicIdentifier>
urn:newsml:audiencemedia.com:20170228:1036-97-7089:1
</PublicIdentifier>
</NewsIdentifier>
<DateLabel/>
<NameLabel/>
<Label>
</Label>
<Label>
<LabelText>Southern Baking 2017</LabelText>
</Label>
<Label>
<LabelText/>
</Label>
</Identification>
<NewsManagement>
<NewsItemType FormalName="News"/>
<FirstCreated>20170228T034353Z</FirstCreated>
<ThisRevisionCreated>20170228T034514Z</ThisRevisionCreated>
</NewsManagement>
<NewsComponent Duid="story_7089">
<NewsLines>
<HeadLine>EDITOR’S LETTER</HeadLine>
<DateLine>20170228T034514Z</DateLine>
<Author>noreply@audiencemedia.com</Author>
<CopyrightLine/>
</NewsLines>
<AdministrativeMetadata>
<Provider>
<Party FormalName="Audience Media"/>
11 www.ziniopro.com

</Provider>
<Creator>
<Party FormalName=""/>
</Creator>
<Property FormalName="Name" Value="Southern Baking 2017"/>
<Property FormalName="CoverDate" Value="1487203200"/>
<Property FormalName="Section" Value="IN THIS ISSUE"/>
</Property>
<ContentItem>
<MediaType FormalName="ComplexData"/>
<MimeType FormalName="text/vnd.IPTC.NITF"/>
<Format FormalName="bcNITF2.5"/>
<Characteristics>
<Property FormalName="WordCount" Value="170"/>
</Characteristics>
<DataContent>
<nitf>
<body>
<body.head>
<headline>EDITOR’S LETTER</headline>
</body.head>
<body.content>
<figure>
<img
src="http://site-1036.audiencemedia.com/var/site_1036/storage/images/media2/
images/f0006-0113/63377-1-eng-GB/f0006-012.jpg" alt=""/>
<figcaption/>
</figure>
<div class="">
<div class="image">
<img
src="http://site-1036.audiencemedia.com/var/site_1036/storage/images/media
2/images/f0006-0113/63377-1-eng-GB/f0006-012.jpg" alt=""/>
<div></div>
</div>
</div>
<p>
Some folks say you’re either a cook or a baker— I think you can be both.
</p>
<p>
Sure, you have to follow a few extra instructions; you have to measure
carefully and stir mindfully. But the results are absolutely worth your
attention to detail. More than a science, baking is a form of magic, where
ingredients like butter, sugar, and flour are transformed into towering
cakes, flaky pies, and perfectly crispy cookies. It’s a sacred practice, a
labor of love that yields the most comforting results.
</p>
<p>
No matter your skill level, this collection of recipes has something perfect
in store for you. Whether you’re ready to try your hand at baking with
yeast, or you’d rather keep it simple with a good, dependable quick bread,
we’ve got you covered.
</p>
<p>
I recommend you brew a pot of coffee, find a comfy spot, and spend a little
time with these recipes. Thumb through the pages, pick out your favorites,
and get ready to start baking. Your family and friends will be so glad you
did.
</p>
<p>Happy Baking!</p>
12 www.ziniopro.com

<div class="">
<div class="image">
<img
<div></div>
</div>
</div>
<div class="">
<div class="image">
<img
<div></div>
</div>
</div>
<div class="">
<div class="image">
<img
<div></div>
</div>
</div>
<div class="">
<div class="image">
<img
<div></div>
</div>
</div>
</body.content>
</body>
</nitf>
</DataContent>
</ContentItem>
</NewsComponent>
</NewsItem>
<NewsItem>
<Identification>
<NewsIdentifier>
<ProviderId>audiencemedia.com</ProviderId>
<DateId>20170228</DateId>
<NewsItemId>1036-97-7096</NewsItemId>
<RevisionId Update="N" PreviousRevision="1">1</RevisionId>
<PublicIdentifier>
urn:newsml:audiencemedia.com:20170228:1036-97-7096:1
</PublicIdentifier>
</NewsIdentifier>
<DateLabel/>
<NameLabel/>
<Label>
</Label>
<Label>
<LabelText>Southern Baking 2017</LabelText>
</Label>
<Label>
<LabelText/>
</Label>
</Identification>
<NewsManagement>
13 www.ziniopro.com

<NewsItemType FormalName="News"/>
<FirstCreated>20170228T034358Z</FirstCreated>
<ThisRevisionCreated>20170228T034514Z</ThisRevisionCreated>
</NewsManagement>
<NewsComponent Duid="story_7096">
<NewsLines>
<HeadLine>BREAKFAST</HeadLine>
<DateLine>20170228T034514Z</DateLine>
<Author>noreply@audiencemedia.com</Author>
<CopyrightLine/>
</NewsLines>
<AdministrativeMetadata>
<Provider>
<Party FormalName="Audience Media"/>
</Provider>
<Creator>
<Party FormalName=""/>
</Creator>
<Property FormalName="Name" Value="Southern Baking 2017"/>
<Property FormalName="CoverDate" Value="1487203200"/>
<Property FormalName="Section" Value="IN THIS ISSUE"/>
</Property>
<ContentItem>
<MediaType FormalName="ComplexData"/>
<MimeType FormalName="text/vnd.IPTC.NITF"/>
<Format FormalName="bcNITF2.5"/>
<Characteristics>
<Property FormalName="WordCount" Value="5"/>
</Characteristics>
<DataContent>
<nitf>
<body>
<body.head>
<headline>BREAKFAST</headline>
</body.head>
<body.content>
<figure>
<img
src="http://site-1036.audiencemedia.com/var/site_1036/storage/images/media2/
images/f0010-0117/63406-1-eng-GB/f0010-012.jpg" alt=""/>
<figcaption>
<p>PECAN STICKY ROLLS page 23</p>
</figcaption>
</figure>
<div class="">
<div class="image">
<img
<div>
<p>PECAN STICKY ROLLS page 23</p>
</div>
</div>
</div>
</body.content>
</body>
</nitf>
</DataContent>
</ContentItem>
14 www.ziniopro.com

</NewsComponent>
</NewsItem>
</NewsML>
15 www.ziniopro.com

ZINIO Pro NewsML Guidelines

Diunggah oleh

Informasi Dokumen

Hak Cipta

Format Tersedia

Bagikan dokumen Ini

Bagikan atau Tanam Dokumen

Opsi Berbagi

Apakah menurut Anda dokumen ini bermanfaat?

Apakah konten ini tidak pantas?

Hak Cipta:

Format Tersedia

ZINIO Pro NewsML Guidelines

Diunggah oleh

Hak Cipta:

Format Tersedia

<NewsComponent> <NewsComponent Duid="story_7089">

Use the parameters below to retrieve page 1 of all stories starting from the latest publish

If less than 50 items are returned, that means that the call already retrieved all the stories

Continue on increasing the page number until you get to the page that returns an empty

Anda mungkin juga menyukai