ログイン

ボランティア情報データベース powered by NPO法人ボランティアインフォ

API利用の手引き

Version 2.1 (Updated:2011-05-03 18:00 JST)
Version2の注意事項(Released 2011-4-25)
  • 過去データはそのままの形式で当面は提供されますが、新規追加されたタグに情報が補足される可能性があります
  • nameおよびcontactの項目は今後利用されなくなります
  • 緯度経度はbodyには含まれなくなります
  • confirmed-by項目はウェブ情報だけをみて問い合わせがあることを防ぐことが目的です。 「必ず○○で最新情報を確認してください」という形で表記してください

ボランティア情報データベースではボランティア情報をRSS形式および独自XML形式で配布しています。

URL

独自XML

※ タグの独自XMLは随時増えます。

※ 地域ごとやジャンルごとなどで独自XMLを作成することも可能です。作成いたしますので info@volunteerinfo.jp にメールでご連絡ください

RSS

※ RSSはご希望あれば作成いたしますのでinfo@volunteerinfo.jpにメールでご連絡ください

取得件数について

現在のところ独自XML形式のものは全件、RSSについては最新の100件を提供しています。ページング等は追って実装されます。

DBの更新と削除の検知について

運用ポリシーとして基本的に更新は行わず削除して新規投入という形をとっています。 そのため、削除済みを含むXMLデータを取得していただきvalid_fフラグをチェックすることで削除チェックが可能です。 なお、RSS形式の item > pubDate は各エントリの更新日を指しています。

API利用側の更新頻度(当APIへのアクセス頻度)については現在のところ1時間に1〜2回程度を推奨しています。

RSS拡張語彙について

名前空間tasukeaiにて下記の情報を埋め込んでいます

緯度経度を含むデータにはgeorss:point形式のデータを含めています

独自XMLのスキーマ

オリジナルのデータ(ruby)をそのままXML形式にしたものです。

name,contactの項目は今後は使われなくなります。

本文内の書式について

下記の例のように本文中に"[key]\nValue"の書式で各種メタデータ的なものが書かれていますが、 データベースとしてはひとつの本文として格納しています。 API利用側で各自パースしてご利用ください。なお、Keyのバリエーションは流動的と考えてください。
[ボランティア名称]
石巻市一般災害ボランティア
[ボランティア概要]
家具の片付けや清掃、避難所のお手伝い
現在規定されているキー: [メッセージ内容] [ボランティア名称] [ボランティア概要] [ボランティア対象] [連絡先電話番号] [連絡先FAX番号] [連絡先メールアドレス] [その他連絡先] [都道府県] [緯度経度] [情報元URL] [情報詳細]

情報の提示方法/リンク先について

RSS/XMLから取得した情報は全て御サイトで表示させることが望ましい形です。 突発的な負荷を避け、安定した入力環境を維持するためにも、 タイトルのみを御サイトで表示し、そこから当サイトの該当ページに動線をはるような形式は好ましくありません。

クレジット表記

個別記事ページには情報ソースとして下記を付加してください

ライセンス

By sa 本APIはCreative Commons BY-SA(表示-継承)ライセンスに基づき提供されます。

※クレジットを表示し、改変した場合には元の作品と同じCCライセンスで公開することを守れば、営利目的での二次利用も許可されます

アクセス制限

現在のところアクセス制限は加えていません。 ただし状況に応じてIPアドレス単位でのアクセス制限をかける可能性があることをご了承ください

連絡先

APIに関するお問い合わせは下記メールアドレスまで
vi-db at googlegroups.com

関連リンク