PRUV APIサービス(XML版)
PRUVの校正機能を外部サイトに提供するAPIです。利用者側の開発が必要ですが、お使いのCMSやブログのエディタなどに組み込むことが可能です。
レスポンスのフォーマットにはXML版とJSON版があります。リクエストパラメータはほぼ同じで、XML版は形態素解析の結果も返します。JSON版についてはPRUV APIサービス(JSON版)を参照してください。
APIを使うには、管理画面で若干設定を行う必要があります。また設定できるのは組織管理者のみです。
「組織/グループ管理」でAPIサービスを「使用する」にします。
画面1 デフォルトは「使用しない」
この時点でAPIの呼び出しが可能です。
画面2 「使用する」にした画面
PRUVに送信するテキストをSSLで暗号化する場合は、「SSLキー(秘密鍵)」に適当な文字列(8~20文字)を入力してください。
なお、APIを利用するユーザーアカウントには二要素認証を設定しないでください。類推されにくいユーザーIDとパスワードを設定してご利用ください。上記のSSLキーを設定すれば、第三者による不正利用の可能性を低減できます(SSLキーが秘密である限り、APIが機能しないため)。
リクエストパラメータ
基本的にサイトの各種設定を利用するため、API呼び出し時のパラメータはシンプルです。
「Version」パラメータを指定すると各種オプションをAPIで制御可能になります。その代わり、全パラメータの有無、評価、設定のオーバーライド処理が発生するため速度は低下します。
id | : | ユーザーID(※必須) |
pass | : | パスワード(※必須) |
usessl | : | on/off(SSLを使うかどうか) |
cdata | : | on/off(CDATAセクションを出力するかどうか) |
sentence | : | 文章(※必須) |
Version | : | 以下のオプション指定に「V2」指定必須 |
Kishuizon | : | 機種依存文字チェック時「checked」 |
Kanji | : | 漢字チェック(1つを指定) 小学校学習漢字(1~6年):l1、l2、l3、l4、l5、l6 常用漢字: joyo 漢字チェックなし: nokanji |
Spell | : | スペルチェック(1つを指定) 英語(米):en_US イタリア語:it_IT スペイン語:es_ES ドイツ語:de_DE フランス語:fr スペルチェックなし:none |
SpellCheckMin | : | スペルチェックの最少文字数(整数値) |
Yure | : | 表記ゆれチェック時「checked」 |
YureMethod | : | 表記ゆれのチェック方法。下記の形式(配列)で指定 ['yure_nglist', 'yure_rs', 'yure_yomi'] yure_nglist:NGリストチェック yure_rs:演算チェック yure_yomi:“読み”チェック |
BStyle | : | 文体統一チェック時「checked」 |
BStyleNum | : | 文体統一チェックで会話文か否かの確認対象範囲。0(無制限)~整数値 |
BStyleOp | : | 文体統一チェックのオプション。下記の形式(配列)で指定 ['notalk'] notalk:会話文を対象外にする |
AI | : | AI使用時「checked」 |
UseExAI | : | 外部AI使用時「checked」 |
ExAI | : | 使用する外部AIを文字列で1つ指定 gpt4omini:GPT-4o mini gemini15flash:Gemini 1.5 Flash claude35sonnet:Claude 3.5 Sonnet aiadvice:AI診断 |
DicSet | : | PRUV提供の標準&カスタム辞書(配列で指定) 例: ['要注意表現辞書', '不快語・差別語辞書', '単位換算辞書'] |
UserDic | : | ユーザー辞書使用時「on」 |
GroupDic | : | グループ辞書使用時「on」 |
UseFrequency | : | 頻出語チェック使用時「checked」 |
FrequencyTarget | : | 頻出語対象品詞。下記の形式(配列)で任意の品詞を指定 ['代名詞', '形式名詞', '名詞', '動詞', '補助動詞', '助動詞', '形容詞', '形容動詞語幹', '補助形容詞', '副詞', '連体詞', '接続詞', '感動詞'] |
FrequencySpan | : | 頻出語チェック対象範囲(整数値) |
UseExtraSearch | : | 外部サービス呼び出し機能使用時「checked」 |
ExtraSearch | : | 外部サービス。下記の形式(配列)で任意のサービスを指定 ['google', 'wikipedia', 'jpweblio', 'jpnifty', 'enggoo', 'engweblio', 'engejiro', 'engnifty', 'thesauweblio', 'thesaurenso', 'thesautamate'] google:Google wikipedia:Wikipedia jpweblio:Weblio国語辞典 jpnifty:@nifty辞書 enggoo:goo英和・和英辞書 engweblio:Weblio英和・和英辞書 engejiro:英辞郎 on the WEB engnifty:@nifty辞書(英和・和英辞典) thesauweblio:Weblio類語辞典 thesaurenso:連想類語辞典 thesautamate:類語玉手箱 |
OptionRule | : | 表記ルールチェック。下記の形式(配列)で任意のルールを指定 ['all_chkZenAlph_kigo', 'all_chkHanKatakana_kigo', 'all_chkHSpace_tokun', 'all_chkFSpace_tokun', 'hb_chkKanma_line', 'hb_number_unit_tokun', 'hb_chkClosebraces_kigo', 'hb_chkClosebracesToten_kigo'] all_chkZenAlph_kigo:全角英数字を使わない all_chkHanKatakana_kigo:半角片仮名を使わない all_chkHSpace_tokun:不要な半角スペースチェック all_chkFSpace_tokun:不要な全角スペースチェック hb_chkKanma_line:数値をカンマ区切りしない hb_number_unit_tokun:桁数の多い数値に万、億、兆を挿入 hb_chkClosebraces_kigo:閉じかぎ括弧直前に句点を付けない hb_chkClosebracesToten_kigo:会話文のみの行末に句点を付けない |
OptionRule_inuki | : | い抜き言葉のチェック設定。下記から1つ選択して指定 all_chkInukion_tokun:い抜き言葉をチェックする all_chkInukihonbun_tokun:い抜き言葉をチェックする(地の文のみ) all_chkInukioff_tokun:い抜き言葉をチェックしない |
Readable | : | 読みやすさチェック使用時「checked」 |
Readable_prof | : | 読みやすさチェックの基準モデル設定。下記から1つ選択して指定 news:新聞(一般紙) it:IT系メディア ent:エンタメ系メディア |
Readable_add | : | 入力した文章の統計データ記録の設定。下記から1つ選択して指定 on:記録する off:記録しない |
CharCount | : | 文字数カウンター使用時「checked」 |
NameYure | : | 名前ゆれチェック使用時「checked」 |
textlint | : | textlint使用時「checked」 |
EndWords | : | 文末表現(連続)でチェック対象にする単語数(整数値) |
EndWordsRenge | : | 文末表現(連続)のチェック対象行数(整数値) |
exEndWords | : | 文末表現(範囲)でチェック対象にする単語数(整数値) |
exEndWordsRenge | : | 文末表現(範囲)のチェック対象行数(整数値) |
管理画面で設定した「SSLキー(秘密鍵)」は送信しないことに注意してください。これらを「&」でつないでURLを構築します。以下は一例です。
?id=ユーザーID&pass=パスワード&usessl=off&sentence=今日は日曜日だ
なお、利用規約の通りユーザーIDを共有することはできません。APIを利用する人数分のユーザーIDを取得してください。1日に使えるリクエスト数はユーザーごとに制限があります。足りない場合はユーザーアカウントを追加してください。
APIの呼び出し
以降で実際のAPI呼び出し方法の詳細を説明します。閲覧にはPRUV Businessのアカウントが必要です。PRUV Businessユーザーの方はログインしてください。