WEKO コンテンツ操作API インターフェース仕様書

■はじめに
　本書は、NetCommons2上で動作するリポジトリモジュール「WEKO」に登録されたコンテンツ情報を
　登録、更新、削除するAPI(コンテンツ操作API)のインターフェース仕様をまとめたものである。
　
　
■NC2/WEKO
　環境はNC2(ver2.4.1.0以上)上で動作しているWEKO(ver.2.0.7以上)を対象とする。
　※WEKO ver.2.0.5以下は更新、削除のAPIが存在しない。
　
　
■コンテンツ操作API 仕様
　WEKOのコンテンツ操作APIはWEKOに登録されたコンテンツ登録、更新、削除を行うAPIである。
　コンテンツ操作APIは、SWORDプロトコルを使用する。
　WEKO ver2.0.7現在で対応しているSWORDはver2.0である。
　（SWORD ver2.0のプロファイル：http://swordapp.github.io/SWORDv2-Profile/SWORDProfile.html）
　
　◆サービス文書取得
　　‐リクエスト先URL
　　　https://xxx.repo.nii.ac.jp/weko/sword/servicedocument.php
　　‐リクエスト情報
　　　　‐Authorization = "[ログインID]:[パスワード]"をBase64でエンコードした文字列（★必須）
　　　　　NC2ユーザー認証情報。
　　　　　「JAIRO Open_SCfWアカウント情報.xls」に記載しているユーザーアカウントをご利用ください。
　　　　‐X-On-Behalf-Of = "[コンテンツ所有者のログインID]"（任意）(※)
　　‐レスポンス
　　　・ステータスコード
　　　　下記いずれかのステータスコードが返ります。
　　　　‐200(OK) ：成功時
　　　　‐400(Bad Request) ：リクエスト取得エラー
　　　　‐401(Unauthorized) ：認証エラー
　　　　‐500(Internal Server Error) ：サーバーエラー
　　　・ボディ：サービス文書（XML）
　　　　「Authorization（X-On-Behalf-Ofがあればこちら）」で指定したユーザーが登録可能なインデックスツリー情報。
　　　　サンプルは下記の通り
　　　　　<?xml version="1.0" encoding="utf-8"?>
　　　　　<service xmlns:dcterms="http://purl.org/dc/terms/" xmlns="http://www.w3.org/2007/app" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:sword="http://purl.org/net/sword/">
　　　　　  <sword:version>2.0</sword:version>
　　　　　  <sword:verbose>false</sword:verbose>
　　　　　  <sword:noOp>false</sword:noOp>
　　　　　  <sword:maxUploadSize>512000</sword:maxUploadSize>
　　　　　  <workspace>
　　　　　    <atom:title>【リポジトリ名|WEKOのGUIから変更可】</atom:title>
　　　　　    <collection href="http://xxx.repo.nii.ac.jp/demo/weko/sword/deposit.php">
　　　　　      <atom:title>Repository Review</atom:title>
　　　　　      <accept>application/zip</accept>
　　　　　      <dcterms:abstract>This is the review repository.</dcterms:abstract>
　　　　　      <sword:mediation>true</sword:mediation>
　　　　　      <sword:treatment>Deposited items(zip) will be treated as WEKO import file which contains any WEKO contents information, and will be imported to WEKO.</sword:treatment>
　　　　　      <sword:collectionPolicy>This collection accepts packages from any admin/moderator users on WEKO.</sword:collectionPolicy>
　　　　　      <sword:formatNamespace>WEKO</sword:formatNamespace>
　　　　　    </collection>
　　　　　    <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:dc="http://purl.org/metadata/dublin_core#">
　　　　　      <rdf:Description rdf:about="http://weko.at.nii.ac.jp/demo/?action=repository_oaiore&amp;indexId=906">
　　　　　        <dc:identifier>【インデックスID】</dc:identifier>
　　　　　        <dc:title>【インデックス名】</dc:title>
　　　　　      </rdf:Description>
　　　　　      ・・・
　　　　　    </rdf:RDF>
　　　　　  </workspace>
　　　　　</service>
　　
　◆登録
　　‐リクエスト先URL（サービス文書から取得したdeposit URL）
　　　https://xxx.repo.nii.ac.jp/weko/sword/deposit.php
　　‐リクエスト情報
　　　・メソッド：POST
　　　・ヘッダー：
　　　　‐Authorization = "[ログインID]:[パスワード]"をBase64でエンコードした文字列（★必須）
　　　　‐Content-Type = "application/zip"（★必須）
　　　　‐Content-Disposition = "filename='[更新用メタデータファイルのファイル名]'"（★必須）
　　　　‐X-On-Behalf-Of = "[コンテンツ所有者のログインID]"（任意）(※)
　　　・ボディ：WEKOインポート形式(.zip)のバイナリデータ
　　‐レスポンス
　　　・ステータスコード
　　　　下記いずれかのステータスコードが返ります。
　　　　‐201(OK)：成功時
　　　　‐400(Bad Request) ：リクエスト取得エラー
　　　　‐401(Unauthorized) ：認証エラー
　　　　‐500(Internal Server Error) ：サーバーエラー
　　　・ボディ：登録結果（XML）
　　　　WEKOに登録したコンテンツのURL一覧。
　　　　サンプルは下記の通り。
　　　　　<?xml version="1.0" encoding="utf-8"?>
　　　　　<entry xmlns="http://www.w3.org/2005/Atom" xmlns:sword="http://purl.org/net/sword/">
　　　　　  <title>Repository Review</title>
　　　　　  <id>【先頭のアイテムID】-【末尾のアイテムID】</id>
　　　　　  <updated>2013-08-20JST16:46:0432400</updated>
　　　　　  <author>
　　　　　    <name>【登録ユーザーのログインID】</name>
　　　　　    <email>【登録ユーザーのメールアドレス】</email>
　　　　　  </author>
　　　　　  # 登録したコンテンツの詳細画面URL
　　　　　  <content type="text/html" src="https://xxx.repo.nii.ac.jp/?action=repository_uri&amp;item_id=【アイテムID】"/>
　　　　　  <content type="text/html" src="https://xxx.repo.nii.ac.jp/?action=repository_uri&amp;item_id=【アイテムID】"/>
　　　　　  ・・・
　　　　　  <source>
　　　　　    <generator uri="https://xxx.repo.nii.ac.jp/weko/sword/deposit.php" version="2"/>
　　　　　  </source>
　　　　　  <sword:treatment>Deposited items(zip) will be treated as WEKO import file which contains any WEKO contents information, and will be imported to WEKO.</sword:treatment>
　　　　　  <sword:formatNamespace>WEKO</sword:formatNamespace>
　　　　　  <sword:userAgent>SWORD Client for WEKO V2.0</sword:userAgent>
　　　　　</entry>
　　
　◆更新
　　‐リクエスト先URL
　　　https://xxx.repo.nii.ac.jp/?action=repository_uri&item_id=[更新を実施するアイテムID]
　　‐リクエスト情報
　　　・メソッド：PUT
　　　・ヘッダー：
　　　　‐Authorization = "[ログインID]:[パスワード]"をBase64でエンコードした文字列（★必須）
　　　　‐Content-Type = "application/zip"（★必須）
　　　　‐Content-Disposition = "filename='[更新用メタデータファイルのファイル名]'"（★必須）
　　　　‐X-On-Behalf-Of = "[コンテンツ所有者のログインID]"（任意）(※)
　　　・ボディ：更新用メタデータファイル(.zip)のバイナリデータ
　　　　　WEKOインポート形式のzipファイル内の「import.xml」に下記の情報を追加したzipファイル。
　　　　　※追記する場所は<repository_item>タグの下とし、<repository_item>タグ1つに対して
　　　　　　<repository_edit>タグが1つ出力されるようにする。
　　　　　　<repository_edit>の属性値 item_id, item_no の値は対応する<repository_item>の
　　　　　　属性値と同値を設定すること。
　　　　-------------------------------------------------------------------------------------------
　　　　　<repository_edit item_id="[ファイル内アイテム通番]" item_no="1">
　　　　　　https://xxx.repo.nii.ac.jp/?action&#61;repository_uri&amp;item_id&#61;[更新を実施するアイテムID]
　　　　　</repository_edit>
　　　　-------------------------------------------------------------------------------------------
　　‐レスポンス
　　　下記いずれかのステータスコードが返ります。
　　　‐200(OK) ：成功時
　　　‐400(Bad Request) ：リクエスト取得エラー
　　　‐401(Unauthorized) ：認証エラー
　　　‐500(Internal Server Error) ：サーバーエラー
　
　◆削除
　　‐リクエスト先URL
　　　https://xxx.repo.nii.ac.jp/?action=repository_uri&item_id=[削除を実施するアイテムID]
　　‐リクエスト情報
　　　・メソッド：DELETE
　　　・ヘッダー：
　　　　‐Authorization = "[ログインID]:[パスワード]" をBase64でエンコードした文字列（★必須）
　　　　‐X-On-Behalf-Of = "[コンテンツ所有者のログインID]"（任意）(※)
　　　・ボディ：なし
　　‐レスポンス
　　　下記いずれかのステータスコードが返ります。
　　　‐204(No Contents) ：成功時
　　　‐401(Unauthorized) ：認証エラー
　　　‐500(Internal Server Error) ：サーバーエラー
　　　
　※ X-On-Behalf-Of は代理投稿で使用します。
　　 指定しない場合は Authorization で指定したログインIDのユーザーをコンテンツ所有者と見なします。
　　 

以上