![[PukiWiki]](image/pukiwiki.png "[PukiWiki]")
データAPI/検索類似語の取得(アプリ向け)
| 名称 | 検索類似語の取得(アプリ向け) |
|---|---|
| APIバージョン | 1 |
| 認証タイプ | クライアント認証 |
| URL | https://(APIサーバー名)/api/(アクセスコード)/ |
| Method | POST |
| データ形式 | application/x-www-form-urlencoded |
検索語の類似語を取得する。
| 引数名 | 値 | 型 | 必須 | 内容 |
| v | 1(固定) | int定数 | 必須 | バージョン番号 現在は1 |
| c | Bn(固定) | string定数 | 必須 | コマンド Bn = BBAPIを呼び出す |
| Category | DCT(固定) | string定数 | 必須 | オペレーションカテゴリー DCT = ディクショナリーデータ |
| Operation | god(固定) | string定数 | 必須 | オペレーション god = GETオペレーション |
| AppKey | アプリケーションキー | string | 必須 | アプリケーションキーペアのアプリケーションキー |
| IDseed | 認証シード | string | 必須 | 認証に使う毎回変わるランダムの文字列 |
| IDval | 認証ハッシュ値 | hash | 必須 | sha1(アプリケーションシークレット+認証シード)の値 |
| StructData | 要求語彙データ | xml | 必須 | 要求語彙データ |
| Format | json,yaml,xml | string定数 | 任意 | 出力フォーマット指定 省略時json(またはアプリケーションキー毎に指定のフォーマット) |
| Charset | UTF-8,SJIS,EUC-JP | string定数 | 任意 | 出力文字コード指定・省略時UTF8 出力フォーマットjson,xml時は常にUTF-8 |
認証パラメーターAppKey,IDseed,IDvalについては、API認証を参照
出力指定パラメーターFormat,Charsetについては、出力フォーマットを参照
QuerySetタグ: ルートノード qtypeタグ: クエリータイプ SimilarWord固定 [必須] wordタグ: 検索語 [必須] maxresultタグ: 取得最大数 [任意]
<?xml version='1.0' encoding='UTF-8' standalone='yes' ?> <QuerySet> <qtype>SimilarWord</qtype> <word>ら</word> <maxresult>10</maxresult> </QuerySet>
| 変数名 | 型 | 内容 |
| api_result | boolean | API実行結果 true:成功 false:失敗 |
| struct | array | 結果データの配列 |
結果データの配列
| 変数名 | 型 | 内容 |
| word | string | 入力語 |
| result | array | 語の列挙 |
{
"api_result":true,
"struct":{
"word":"\u3089",
"result":[
"\u3089",
"\u3089\u30fc",
"\u3089\u30fc\u304f\u308a\u307e\u304f",
"\u3089\u30fc\u3053\u3093\u3057\u304a",
"\u3089\u30fc\u3053\u3093\u3057\u3087",
"\u3089\u30fc\u3053\u3093\u3068\u3093",
"\u3089\u30fc\u3053\u3093\u307f\u305d",
"\u3089\u30fc\u3058",
"\u3089\u30fc\u3058\u3055\u3044\u305a",
"\u3089\u30fc\u3058\u306c\u30fc\u3069",
"\u3089\u30fc\u3058\u3089\u3044\u3059"
]
}
}
<?xml version="1.0" encoding="UTF-8"?> <response> <api_result>1</api_result> <struct> <word>ら</word> <result> <item>ら</item> <item>らー</item> <item>らーくりまく</item> <item>らーこんしお</item> <item>らーこんしょ</item> <item>らーこんとん</item> <item>らーこんみそ</item> <item>らーじ</item> <item>らーじさいず</item> <item>らーじぬーど</item> <item>らーじらいす</item> </result> </struct> </response>
PHPサンプル サンプル/PHP/データAPI/検索類似語の取得(アプリ向け)
このドキュメントのバージョン情報
| Version | 1 |
| Revision | 1 |
| Editor | west |
