Länkar
- XML-struktur för material
- XML-struktur övriga vyer - search, pressroom_info, blogstream
- Förteckning över våra kategorier
Introduktion
MyNewsdesks Webservice för pressrum är ett sätt för dig som registrerad kund eller partner att hantera ditt pressrum på Newsdesk från valfritt system. Du kan hämta all din information som XML och skapa epost-prenumerationer på ditt material.
För enklaste möjliga implementation, och maximal plattformsoberoende, bygger hela tjänsten på HTTP, med enkla GET/POST-anrop för de olika funktionerna. Dina svar får du som XML och/eller HTTP-statuskoder.
Innan du kan komma igång med tjänsten behöver du först få den aktiverad hos oss, samt erhålla din unika nyckel. Du använder nyckeln i alla anrop för autentisering.
http://www.mynewsdesk.com/services/pressroom/tjänst/unik nyckel/?parameter=värde¶meter=värde
Den här strukturen används för alla tjänster. Namnet på var och en av tjänsterna, samt vilka parametrar som krävs för varje tjänst, hittar du i förteckningen nedan.
Tjänster
Här listas de funktioner som finns tillgängliga i den senaste versionen av Webservice för pressrum.
- list - Lista material
- view - Visa enskilt material
- search - Sök material
- subscribe - Skapa prenumeration
- send_email - Skicka material som epost
- pressroom_info - Visa information från pressrum
- create_comment - Skapa kommentar
- blogstream - Lista blogglänkar
list - Lista material
http://www.mynewsdesk.com/services/pressroom/list/din_nyckel/?[type_of_media=pressrelease|news|blog_post|event|image|video|document|contact_person]&[limit=limit]&[offset=offset]&[order=published|updated|created]&[format=xml|rss]
Tar emot
HTTP GET request.
Returnerar
XML över HTTP. Statuskod "200 OK" vid lyckad request. Statuskod "404 Not Found" om materialet inte kunde hittas. Anges "format=rss" returneras resultatet som RSS.
Frivilla parametrar
-
type_of_media (Default: pressrelease)
Bestämmer vilken typ av material som ska hämtas.
-
limit (Default: 20)
Maximalt antal releaser i svaret. Maximalt 100 st.
-
offset (Default: 0)
Anger vilket dokument i ordningen som ska vara det första i svaret.
-
order (Default: published)
Anger vilken ordning resultatet ska sorteras efter; publiseringsdatum (published), senaste uppdateringen (updated) eller när dokumentet skapades (created).
-
format (Default: xml)
Bestämmer vilket format som ska returneras från anropen, XML eller RSS.
-
pressroom
Bestämmer från vilket pressrum materialet skall tas. 'se' för svenskt pressrum, 'no' för norskt pressrum och 'en' för globalt pressrum. Om parametern inte anges listas material från alla pressrum.
view - Visa enskilt material
http://www.mynewsdesk.com/services/pressroom/view/din_nyckel/?[item_id=id]&[type_of_media=pressrelease|news|blog_post|event|image|video|document|contact_person]
Tar emot
HTTP GET request.
Returnerar
XML över HTTP. Statuskod "200 OK" vid lyckad request. Statuskod "404 Not Found" om materialet inte kunde hittas.
Obligatoriska parametrar
-
item_id
ID på den release som ska hämtas.
Frivilla parametrar
-
type_of_media (Default: pressrelease)
Bestämmer vilken typ av material som ska hämtas.
search - Sök material
http://www.mynewsdesk.com/services/pressroom/search/din_nyckel/?[query=query]&[type_of_media=pressrelease|news|blog_post|event|image|video|document|contact_person]&[limit=limit]&[page=page]&[format=xml|rss]
Tar emot
HTTP GET request.
Returnerar
XML eller RSS över HTTP. Statuskod "200 OK" vid lyckad request. Anges "format=rss" returneras resultatet som RSS.
Frivilla parametrar
-
query
Söksträng. Sökningen sker i alla textfält på materialet, såsom rubrik, sammanfattning och brödtext. Sökningen har stöd för "AND/OR/NOT", samt wildcards (*).
-
type_of_media (Default: pressrelease)
Bestämmer vilken typ av material som ska hämtas.
-
limit (Default: 20)
Antal releaser per sida. Maximalt 100 st.
-
page (Default: 1)
Sida i sökresultatet
-
format (Default: xml)
Bestämmer vilket format som ska returneras från anropen, om inget anges returneras XML, om RSS anges som format så returneras listan som RSS.
-
pressroom
Bestämmer från vilket pressrum sökningen skall göras. 'se' för svenskt pressrum och 'no' för norskt pressrum. Om parametern inte anges görs sökningen på alla existerande pressrum.
subscribe - Skapa prenumeration
http://www.mynewsdesk.com/services/pressroom/subscribe/din_nyckel/?[newsdesk_subscriber_email=adress]&[newsdesk_subscribe_to_[pressreleases|news|blog_posts|events|images|videos|documents|contact_people]=1]
Tar emot
HTTP POST request.
Returnerar
Statuskod "200 OK" vid lyckad request. Statuskod "422 Unprocessable Entity" om prenumerationen inte kunde skapas.
Obligatoriska parametrar
-
newsdesk_subscriber_email
Epostadress till prenumeranten.
-
newsdesk_subscribe_to_xxx
Skicka en parameter med värdet "1" för varje typ av material som ska omfattas av prenumerationen. Krävs minst en typ.
-
newsdesk_pressroom
Bestämmer på vilket pressrum prenumerationen ska skapas. 'se' för svenskt pressrum, 'no' för norskt pressrum och 'en' för globalt pressrum. Om parametern inte anges skapas prenumerationen på företagets första/enda pressrum.
send_email - Skicka material som epost
http://www.mynewsdesk.com/services/pressroom/send_email/din_nyckel
Tar emot
HTTP POST request.
Returnerar
Statuskod "200 OK" vid lyckad request. Statuskod "422 Unprocessable Entity" vid felaktigt anrop.
Obligatoriska parametrar
-
item_id
ID på den release som ska skickas.
-
to_email
Mottagarens e-postadress.
Frivilla parametrar
-
type_of_media (Default: pressrelease)
Bestämmer vilken typ av material som ska skickas. En av "pressrelease", "news", "blog_post","event", "image", "video", "document" eller "contact_person".
-
from
Namn på avsändaren.
-
message
Avsändarens personliga meddelande till mottagaren.
Metoden skickar ett e-postmeddelande till mottagaren, med en länk till materialet och avsändarens personliga meddelande.
pressroom_info - Visa information från pressrum
http://www.mynewsdesk.com/services/pressroom/pressroom_info/din_nyckel?[pressroom=se|no|en]
Tar emot
HTTP GET request.
Returnerar
Statuskod "200 OK" vid lyckad request. Statuskod "404 Not Found" om pressrumet inte kunde hittas.
Frivilla parametrar
-
pressroom
Bestämmer vilket pressrum som ska hämtas. 'se' för svenska pressrumet, 'no' för norska pressrumet och 'en' för globala pressrumet. Om parametern inte anges hämtas det första/enda pressumet.
Den XML som returneras innehåller "tag cloud", företagsbeskrivning, presskontakter etc - precis som företagets pressrum på www.mynewsdesk.com.
Ett "tag cloud" är en grafisk representation av hur ofta en tagg förekommer i pressrumet, på en skala mellan 1-5. De mest populära taggarna är större.
create_comment - Skapa kommentar
http://www.mynewsdesk.com/services/pressroom/create_comment/din_nyckel
Tar emot
HTTP POST request.
Returnerar
Statuskod "200 OK" vid lyckad request. Statuskod "422 Unprocessable Entity" om kommentaren inte kunde skapas.
Obligatoriska parametrar
-
commentable_id
ID på den release som kommenteras.
-
type_of_media
Materialets typ. En av "pressrelease", "news", "blog_post", "event", "image", "video", "document" eller "contact_person".
-
name
Kommentatorns namn.
-
body
Kommentarens innehåll.
-
email
Kommentatorns e-postadress.
-
user_ip
Kommentatorns ip-nummer. Detta behövs för att vi lättare skall kunna urskilja de kommentarer som är spam.
Frivilliga parametrar
-
blog
Kommentatorns blogg/webbplats.
blogstream - Lista blogglänkar
http://www.mynewsdesk.com/services/pressroom/blogstream/din_nyckel/?url=url
Tar emot
HTTP GET request.
Returnerar
RSS över HTTP. Statuskod "200 OK" vid lyckad request. Statuskod "422 Unprocessable Entity" om felaktig URL-parameter angetts.
Obligatoriska parametrar
-
url
URL till sidan blogglänkarna pekar mot. Måste vara en korrekt URL, tex "http://www.mynewsdesk.com/se/pressroom/google/pressrelease/view/nu-lanserar-vi-svenska-youtube-youtubes-nya-svenska-sajt-goer-det-enklare-att-hitta-svenska-videor-247863"