用語集参照 APIの使い方

用語集参照APIは、用語集Q&Aディレクトリの指定したページを取得する機能を提供します。

リクエスト例

http://ossipedia.ipa.go.jp/webapi/getkb?key=XXXXXXXX&query=Linux&format=html

リクエストURL

http://ossipedia.ipa.go.jp/webapi/getkb

リクエストパラメータ

パラメータ 説明 デフォルト値
key(必須) OSS iPedia webAPIの利用キー string
query(必須) 用語集のタイトル string
format レスポンス内の配信物のフォーマット。"plain"または"html"から選択する string plain

レスポンス例

format=plain

format=html

レスポンス

フィールド 説明 親要素
kb レスポンスの全てを含む要素 なし
title 配信物のタイトル kb
url 配信物の存在するURL kb
body 配信物 kb
content:encoded 配信物 kb

エラーレスポンス例

エラーレスポンス

フィールド 説明 親要素
Error エラーコード+エラーメッセージ なし

エラーコード

コード 説明
400 Bad request. 渡されたパラメータが期待されたものと異なる場合
403 Forbidden. アクセスを許されていない場合
404 Not Found. 指定されたリソースが見つからない場合

サンプルコード