CiNii - Metadata and API

Contents

 

Outline

CiNii provides Web API (Application Program Interface) for system linkages. The following four-type forms are being provided.

Please register and get your application ID for API from "API User Registration".

 

OpenURL

OpenURL is a standard of URL for transferring bibliographic information such as articles, books and journals between systems. It is used for the linking with library OPAC (Online Public Access Catalog), link resolver and so on. For more details about OpenURL, please refer to "OpenURL - Wikipedia, the free encyclopedia".

CiNii offers the OpenURL receiving function. By describing links with the OpenURL format enables the links to specific articles, journal information, or search results.

Also, CiNii has the OpenURL sending function (display function to link resolver or OPAC at Article details page at CiNii Research, Book and Journal details page at CiNii Books). For more details, please see "OpenURL Sending Function".

[Function Diagram] (The OpenURL in the diagram has been simplified)

Please see the each API page for the details such as receivable parameters.

 

OpenSearch

OpenSearch is a standard for using search results freely from other websites in the web services. For more details, please refer to "OpenSearch 1.1 Draft 6 Specification".

OpenSearch is available in the following three ways.

 

A. Search for Articles with your browser's search bar.

It is available to search for CiNii Research with the search bar on Firefox.

  1. Display the CiNii page by Firefox. After clicking on the icon "+" of the left end of search box, select [Add earch engine "CiNii Research - all"] and add it (This work is required only one time for the first time.).

  2. Enter keywords in the search bar, and select "CiNii OpenSearch" .

  3. The browser will take you to the article search results page.

 
 

B. Request query of OpenSearch to CiNii

Making query of OpenSearch and request to CiNii enable you to search equivalent with search on the screen of CiNii. You can use for system linkages and so on.

"Access-Control-Allow-Origin*" is required on http header for response, and it is available to use asynchronous communication between cross domains.

Example of query (CiNii Research OpenSearch for Articles):

https://cir.nii.ac.jp/opensearch/articles?q=%E5%AE%89%E9%81%94&count=20&start=1&lang=en&title=library&format=rss

Example of response (RSS feed):

Query Specification and Response Specification

CiNii OpenSearch is prepared for each search type. Specification of query and response for each search type, please see the following API page.

 

RDF

RDF (Resource Description Framework) is a standard for expression of metadata (data about data). In CiNii, each data item such as titles and authors can be obtained as structured metadata like Dublin Core, which is one of standard expressions of standard data description specifications, with RDF/XML.

"Access-Control-Allow-Origin*" is required on http header for response, and it’s available to use asynchronous communication between cross domains.

For more details, please refer to "RDF - Semantic Web Standards".

 

How to get RDF

By Specifying URI

  1. Display the article details page. (RDF can be outputted by papers, authors, books/ journals and libraries for each.)

  2. Add ".rdf" to the URL in the address bar. Even if the RDF URI is inputted directly, the same results are displayed because the RDF URI becomes "details page URL" plus ".rdf".
    For example: http://ci.nii.ac.jp/naid/110004744915 -> http://ci.nii.ac.jp/naid/110004744915.rdf

  3. The content of the article details page will be outputted with RDF.


Content Negotiation

Content Negotiation is also acceptable. Even if RDF URI is not be specified, RDF will respond by recognition from HTTP header. In the Article details page (For example: https://cir.nii.ac.jp/crid/1390006432294648704), specification of "application/rdf+xml" in accept field of HTTP request header has much priority than any other specifications, it will induce automatically to RDF URI.

 

JSON-LD (Beta version)

JSON-LD is a specification to express linked data with JSON format and standardized by W3C (the World Wide Web Consortium). It is available to get equivalent Metadata to RDF with JSON-LD format.

"Access-Control-Allow-Origin*" is required on http header for response, and it is available to use asynchronous communication between cross domains.

Note: This API is based on "JSON-LD 1.0 A JSON-based Serialization for Linked Data W3C Candidate Recommendation 10 September 2013". The latest specification is "JSON-LD 1.0".It is a recommendation by W3C on January 16, 2014.

For more details, please refer to the following page.

 

How to get JSON-LD

By specifying the URI

  1. Display the Article Details Page(It is available to output in each for Articles, Authors, Book & Journal and Library).

  2. Add ".json" to URL address. JSON-LD URI means "the Article Details Page" plus ".json" so the same result will be displayed when you enter JSON-LD URI directly.
    For example: https://cir.nii.ac.jp/crid/1390006432294648704 -> https://cir.nii.ac.jp/crid/1390006432294648704.json

  3. 3. A content of the Article Details Page will be output by JSON-LD.


Content Negotiation

Content Negotiation is also acceptable. Even if JSON-LD URI is not be specified, JSON-LD will respond by recognition from HTTP header. In the Article Details Page (For example: https://cir.nii.ac.jp/crid/1390006432294648704), specification of "application/json" or "application/ld+json" in accept field of HTTP request header has much priority than any other specifications, it will induce automatically to JSON-LD URI.

 

Release of NACSIS-CAT records through CiNii Books API with CC-BY license

NACSIS-CAT records on CiNii Books are available as Open Data licensed by CC BY 4.0Attribution 4.0 International of Creative Commons. Under the license, it is available to obtain the data through CiNii Books API.

Regarding release policy of NACSIS-CAT records, please refer to "Release of NACSIS-CAT records" (Written in Japanese).

How to use

  1. Register and get your application ID for API from "API User Registration".
  2. btain the data along the CiNii Books API Specification. In API provided by CiNii Books, the following output data is available as Opendata.

Note: Abstracts & Contents are unavailable due to base on the contracts with providers. For more details, please refer to "Copyright and Linking".

Update Information

Updated data of the previous week will be reflected in the early morning every Monday.

For users of Dataset

We also release as Dataset for applicants who wish to obtain data together. Data format is RDF(RDF/XML), and scheduled update information will be once a year for the time being. For more details, please refer to "Release of NACSIS-CAT records"”(Written in Japanese).