|
|
Nokia Content Syndication Program (NCSP) |
|
Home
 Getting Started
FAQ
Export Control
XML Resources
|
Home > Getting Started
Getting Started with NCSP The Nokia Content Syndication Program (NCSP) is essentially two services. First, NCSP offers syndicated content via XML data feeds. Secondly, NCSP offers a Download Service for Software and Documents. Access to the XML: XML feeds can be generated by the NCSP server. For a simple example to get started with, try this URI: http://ncsp.forum.nokia.com/csp/?b=content;class=application;f=rss10 The link above will generate a list (in RSS 1.0) of applications currently in the system. Filtering: The base URL you will be working with is "http://ncsp.forum.nokia.com/csp/?b=content". From that, you can apply rules and filters via key/value pairs appended to the base URL request. Content can be filtered by topic, type, and language. In addition, the list contents can be limited by accessing custom content collections or setting the maximum number of items to return. When returning links, you have control over arguments that can appended to the download URL's. The key/value pair "b=content" will always be required (it tells the system that you're interested in a content listing.) However, beyond that you have control over a wide range of filtering options which can be combined as needed. The following Keywords can be passed to the XML generating code: aid When tracking an asset for changes or updates, it can be useful to limit the XML results to a single asset. This can be done using the keyword "aid" and setting it to a specific asset ID number. For example, if you were tracking asset numebr '1', you could use this URL: http://ncsp.forum.nokia.com/csp/?b=content;aid=1 class The 'class' keyword is used to limit the content results by a particular type. The most common types used are "document" and "application". To view all applications, use the following URL: http://ncsp.forum.nokia.com/csp/?b=content;class=application format The "format" keyword is shortened to the character 'f' when passing it as an argument. Format is used to select the output-format that should be generated. If no format is selected (or an unknown format is selected), the NCSP system will return the results in HTML. Currently, the most popular formats are: "rss091", which generates RSS 0.91; "rss092", which generates RSS 0.92; and "rss10", which generates RSS 1.0. Setting "f" to "rss" will allow the system to publish the latest RSS format supported. [NOTE: When possible, the system expands the metadata offered in RSS using Dublin Core metadata and namespaces.] To view all documents as RSS 1.0, use the following URL: http://ncsp.forum.nokia.com/csp/?b=content;class=application;f=rss10 lang Results can also be limited by language. To return only documents in English, use the key/value pair "lang=en". As an example, to obtain a list of documents in Chinese ("zh"), you could use the following URL: http://ncsp.forum.nokia.com/csp/?b=content;class=document;f=rss;lang=zh limit To limit the number of items returned, use the key "limit" and pass an integer for it's value. For example, to create an RSS 0.92 feed with only 5 applications, you could use this URL: http://ncsp.forum.nokia.com/csp/?b=content;class=application;limit=5;f=rss092 Limit can also be used to extract a range (often used for pagination.) To do this, pass limit two integers delimited with a comma (ex., limit=10,20). We can modify the previous request to return 10 items, starting with position 5 [NOTE: limit is zero-based, meaning that limit=0,5 will return the first 5 items, '0' being the first.] http://ncsp.forum.nokia.com/csp/?b=content;class=application;limit=5,10;f=rss092 ref The XML files have public read permissions, meaning anyone with the URL can access them; However, the hyperlinks to "restricted" downloads will not work until you have authenticated with the Download Service. By signing on as an NCSP partner, our technical team will assign you a reference code that needs to be appended to the download URL's. This can be done manaually, or automatically by our system. To append your reference code automaticaly, pass in the key/value pair "ref=YOURKEYID" (where "YOURKEYID" is your reference code) when generating the XML feed. topic The "topic" keyword is used to filter a result set by topic(s). Topic is the only keyword that allows multiple arguments to be passed in; meaning, you can combine topic in an "AND" relationship. Values are combined using commas. For example, to generate an RSS 1.0 feed listing only Java documents, you would use: http://ncsp.forum.nokia.com/csp/?b=content;class=document;topic=java;f=rss10 To generate an RSS 1.0 feed listing documents that are classified as both Java AND Symbian, you would use: http://ncsp.forum.nokia.com/csp/?b=content;class=document;topic=java,symbian;f=rss10 notimestamp When the NCSP system generates download links, a time-stamp can be automatically appened to each URL. If you need to disable this time-stamp for integration reasons, pass in the following key/value pair: "notimestamp=1". Passing in "notimestamp=0" will ensure that time-stamps are appended to your URL's. To view all Chinese documents, with no time-stamp in the download links, construct a request like this: http://ncsp.forum.nokia.com/csp/?b=content;class=document;f=rss;lang=zh;notimestamp=1 If you have any questions or comments, please contact . For links to XML Tools and Books, check out our XML Resources Page. |