• logo 文章校正サービスPRUV(プルーフ)
  • manual 使い方
    • spec 主な機能
    • spec editon 主な機能(エディション別)
  • utility ユーティリティー
    • speech 文章読み上げモード
    • counter 文字数カウンター
    • cyrillic キリル-ラテン変換
    • day calc 日数計算機
    • price calc 金額計算機
    • diff diff(テキスト比較)
  • listen お問い合わせ
    • faq FAQ
  • signup ユーザー登録
  • login ログイン
  • PRUVの使い方
  • 文章チェック機能
    • PRUVの基本操作(文章チェック実行前)
    • PRUVの基本操作(ドラッグ&ドロップ入力)
    • PRUVの基本操作(文章チェック実行後)
    • PRUVの基本操作(オプション機能)
    • 形態素解析機能の使い方
    • 読みやすさチェック機能
  • ログインユーザー向け機能
    • PRUVへのログイン
    • PRUVにログイン後のメニュー
    • ユーザープロファイルの設定
    • 画面表示設定
    • PRUV Trial/Proの共有辞書
    • 単位換算機能
    • 二要素認証によるログイン
    • PRUV Proへのアップグレード
    • PRUV Proの契約管理
    • 表記ルールチェック機能
    • AIチェック機能
    • 文末表現チェック機能
    • 頻出単語チェック機能
    • オプション辞書の使い方
    • 外部サービス呼び出し機能
    • textlint機能
    • 文字数カウンター
    • 設定プリセット機能
    • 読み上げモード
  • ユーザー辞書の編集
    • 辞書管理画面
    • 辞書ルールチェッカー
    • チェックルール作成入門
    • チェックルールの簡易テスト
    • 単語ルール編
    • 2単語ルール編
    • 単語(品詞指定)ルール編
    • 2単語(品詞指定)ルール編
    • 2単語(後方一致)ルール編
    • 3単語ルール編
    • 係り受け関係ルール編
    • 単語キャンセルルール編
    • 2単語キャンセルルール編
    • フレーズルール編
    • もしかしてルール編
    • スペルチェックルール編
  • 組織、ユーザー管理機能
    • 組織/グループの管理
    • ユーザーの管理
    • ユーザー設定一括管理
    • 管理者によるユーザーの追加
    • ユーザー登録(一括)用定義ファイルについて
    • メールレス運用ガイド
  • Business向け機能
    • PRUV APIサービス(XML版)
    • PRUV APIサービス(JSON版)
    • PRUV APIサービス(辞書API)

PRUV APIサービス(辞書API)

PRUVの辞書管理機能を外部から操作するためのAPIです。利用者側の開発が必要ですが、お使いのアプリケーションなどに組み込むことが可能です。なお、APIを利用できるのはPRUV Businessのみです。

APIを利用するユーザーアカウントには二要素認証を設定しないでください。類推されにくいユーザーIDとパスワードを設定してご利用ください。

リクエストパラメータ

辞書APIはユーザーID(id)とパスワード(pass)、APIで実行する操作(mode)とmodeのオプションで構成します。modeによって必須のオプション、任意指定のオプションがあります。

辞書APIはSSLキーに対応していません。

mode:test(APIの動作テスト)

ユーザー認証だけ行って「OK」を返します。


//サンプルコード
$data = [
  'id'=>'ユーザーID',
  'pass'=>'パスワード',
  'mode'=>'test',
];

//戻り値例
{"result":"OK"}

mode:getRemainColum(残り登録可能数)

指定した辞書に登録できるルールの残数(辞書の容量-登録数)を返します。

オプション(対象辞書を指定)
パーソナル辞書:無指定/グループ辞書:'grp'+グループID


//サンプルコード
$data = [
  'id'=>'ユーザーID',
  'pass'=>'パスワード',
  'mode'=>'getRemainColum',
  'grp'=>'グループID',//グループ辞書の場合は'grp'を指定。IDは管理画面の「組織/グループ管理」で確認可
];

//戻り値例
{"result":29979}

mode:countColumbyDicid(現在登録数)

指定した辞書の登録済みルール数を返します。

オプション(対象辞書を指定)
パーソナル辞書:無指定/グループ辞書:'grp'+グループID


//サンプルコード
$data = [
  'id'=>'ユーザーID',
  'pass'=>'パスワード',
  'mode'=>'countColumbyDicid',
  //ユーザーIDのパーソナル辞書の場合は辞書指定なし
];

//戻り値例
{"result":21}

mode:getDicRuleId(登録済みルールID)

指定したルールのID(各ルールに付与されたユニークなID)を返します。

オプション(ルールの検索条件を指定)
パーソナル辞書:無指定/グループ辞書:'grp'+グループID
ルールのタイプ(必須):'rule'+ルールのタイプ
ルールの対象文字列(必須):'keyword'+対象語


//サンプルコード
//'グループID'辞書で'word'(単語)の「人口知能」ルールを検索
$data = [
  'id'=>'ユーザーID',
  'pass'=>'パスワード',
  'mode'=>'getDicRuleId',
  'grp'=>'グループID',//グループ辞書の場合は'grp'を指定。IDは管理画面の「組織/グループ管理」で確認可
  'rule'=>'word',
  'keyword'=>'人口知能',
];

//戻り値例(複数マッチする場合があるため配列で戻します)
{"result":[{"id":"647c1209e2f7e078257595b4","keyword":"\u4eba\u53e3\u77e5\u80fd",(以下略)}]

mode:deleteRule(指定したルールの削除)

指定したルールを削除します。

オプション(対象辞書とルールIDを指定)
パーソナル辞書:無指定/グループ辞書:'grp'+グループID
ルールID(必須):'ruleid'+ルールID(getDicRuleIdの返り値)


//サンプルコード
$data = [
  'id'=>'ユーザーID',
  'pass'=>'パスワード',
  'mode'=>'deleteRule',
  'grp'=>'グループID',//グループ辞書の場合は'grp'を指定。IDは管理画面の「組織/グループ管理」で確認可
  'ruleid'=>'XXXXXXXXXXXX', //getDicRuleIdで検索したルールID
];

//戻り値例
{"result":"\u6307\u5b9a\u3055\u308c\u305f\u30eb\u30fc\u30e……
//デコード→指定されたルールIDのルールを削除しました。

mode:addRule(指定した辞書にルールを追加)

指定した辞書にルールを追加します。

オプション(対象辞書とルールのタイプ、ルールの詳細を指定)
パーソナル辞書:無指定/グループ辞書:'grp'+グループID
ルールのタイプ(必須):'rule'+ルールのタイプ
ルールの詳細(必須):ルールのタイプによって異なる


//サンプルコード(word)
$data = [
  'id'=>'ユーザーID',
  'pass'=>'パスワード',
  'mode'=>'addRule',
  'grp'=>'グループID',//グループ辞書の場合は'grp'を指定。IDは管理画面の「組織/グループ管理」で確認可
  'rule'=>'word',
  'keyword'=>'人口知能',
  'correct'=>'人工知能',
  'comment'=>'「人口」は「人工」の誤変換です。',
];

//サンプルコード(wordhinshi)
$data = [
  'id'=>'ユーザーID',
  'pass'=>'パスワード',
  'mode'=>'addRule',
  'grp'=>'グループID',//グループ辞書の場合は'grp'を指定。IDは管理画面の「組織/グループ管理」で確認可
  'rule'=>'wordhinshi',
  'keyword'=>'さぼる',
  'correct'=>'サボる',
  'key_hinshi'=>'動詞',
  'comment'=>'「さぼ」は片仮名にした方が自然です。',
  'autovar'=>'autovar',//「さぼる」「サボる」の活用形を自動生成
];

//サンプルコード(kakariuke)
$data = [
  'id'=>'ユーザーID',
  'pass'=>'パスワード',
  'mode'=>'addRule',
  'grp'=>'グループID',//グループ辞書の場合は'grp'を指定。IDは管理画面の「組織/グループ管理」で確認可
  'rule'=>'kakariuke',
  'keyword'=>'物議',
  'uke'=>'醸し出す',
  'comment'=>'「物議を醸す」の誤りです。',
  'autovar'=>'autovar',//「醸し出す」の活用形を自動生成
];

//戻り値例
{"result":"\u30eb\u30fc\u30eb\u306e\u8ffd\u52a0\uff0f\u590……
//デコード→ルールの追加/変更に成功しました。

mode:updateRule(指定したルールを変更)

指定したルールを変更します。

オプション(ルールID、対象辞書、ルールのタイプ、ルールの詳細を指定)
パーソナル辞書:無指定/グループ辞書:'grp'+グループID
ルールID(必須):'ruleid'+ルールID(getDicRuleIdの返り値)
ルールのタイプ(必須):'rule'+ルールのタイプ
ルールの詳細(必須):ルールのタイプによって異なる
※updateRuleでは'autovar'は無視されます。


//サンプルコード
$data = [
  'id'=>'ユーザーID',
  'pass'=>'パスワード',
  'mode'=>'updateRule',
  'ruleid'=>'XXXXXXXXXXXX', //getDicRuleIdで検索したルールID
  'grp'=>'グループID',//グループ辞書の場合は'grp'を指定。IDは管理画面の「組織/グループ管理」で確認可
  'rule'=>'word',
  'keyword'=>'人口知能',
  'correct'=>'人工知能',
  'comment'=>'「人口」は「人工」の誤変換です。',
];

//戻り値例
{"result":"\u30eb\u30fc\u30eb\u306e\u8ffd\u52a0\uff0f\u590……
//デコード→ルールの追加/変更に成功しました。

mode:getRemainSpellColum(スペルチェック用辞書の残り登録可能数)

指定したスペルチェック辞書に登録できる単語の残数(辞書の容量-登録数)を返します。

オプション(対象辞書を指定)
パーソナル辞書:無指定/グループ辞書:'grp'+グループID


//サンプルコード
$data = [
  'id'=>'ユーザーID',
  'pass'=>'パスワード',
  'mode'=>'getRemainSpellColum',
  'grp'=>'グループID',//グループ辞書の場合は'grp'を指定。IDは管理画面の「組織/グループ管理」で確認可
];

//戻り値例
{"result":4912}

mode:getCurrentSpellNum(スペルチェック用辞書の現在登録数)

指定したスペルチェック辞書の登録済み単語数を返します。

オプション(対象辞書を指定)
パーソナル辞書:無指定/グループ辞書:'grp'+グループID


//サンプルコード
$data = [
  'id'=>'ユーザーID',
  'pass'=>'パスワード',
  'mode'=>'getCurrentSpellNum',
  'grp'=>'グループID',//グループ辞書の場合は'grp'を指定。IDは管理画面の「組織/グループ管理」で確認可
];

//戻り値例
{"result":88}

mode:getSpellWordKey(スペルチェック用単語のキー)

指定したスペルチェック辞書の単語を特定するキーを返します。

オプション(対象辞書を指定)
パーソナル辞書:無指定/グループ辞書:'grp'+グループID
検索対象の単語:'word'+単語


//サンプルコード
$data = [
  'id'=>'ユーザーID',
  'pass'=>'パスワード',
  'mode'=>'getSpellWordKey',
  'grp'=>'グループID',//グループ辞書の場合は'grp'を指定。IDは管理画面の「組織/グループ管理」で確認可
  'word'=>'Windows',
];

//戻り値例
{"result":7}

mode:addSpell(スペルチェック用単語を登録)

指定したスペルチェック辞書に単語を登録します。

オプション(対象辞書を指定)
パーソナル辞書:無指定/グループ辞書:'grp'+グループID
登録する単語:'word'+単語


//サンプルコード
$data = [
  'id'=>'ユーザーID',
  'pass'=>'パスワード',
  'mode'=>'addSpell',
  'grp'=>'グループID',//グループ辞書の場合は'grp'を指定。IDは管理画面の「組織/グループ管理」で確認可
  'word'=>'macOS',
];

//戻り値例
{"result":"\u30b9\u30da\u30eb\u30c1\u30a7\u30c3\u30af\u7528\(以下略)}]
//デコード→スペルチェック用の単語を登録しました。

mode:updateSpell(スペルチェック用単語を更新)

指定したスペルチェック辞書に登録されている単語を更新します。存在しない単語キーを指定した場合は更新ではなく登録(addSpellと同じ動作)をします。

オプション(対象辞書を指定)
パーソナル辞書:無指定/グループ辞書:'grp'+グループID
更新する単語:'word'+単語
単語のキー:'wordkey'+単語キー


//サンプルコード
$data = [
  'id'=>'ユーザーID',
  'pass'=>'パスワード',
  'mode'=>'updateSpell',
  'grp'=>'グループID',//グループ辞書の場合は'grp'を指定。IDは管理画面の「組織/グループ管理」で確認可
  'word'=>'Linux',
  'wordkye'=>7,
];

//戻り値例
{"result":"\u30b9\u30da\u30eb\u30c1\u30a7\u30c3\u30af\u7528\(以下略)}]
//デコード→スペルチェック用の単語を更新しました。

mode:deleteSpell(スペルチェック用単語を削除)

指定したスペルチェック辞書に登録されている単語を削除します。

オプション(対象辞書を指定)
パーソナル辞書:無指定/グループ辞書:'grp'+グループID
単語のキー:'wordkey'+単語キー


//サンプルコード
$data = [
  'id'=>'ユーザーID',
  'pass'=>'パスワード',
  'mode'=>'deleteSpell',
  'grp'=>'グループID',//グループ辞書の場合は'grp'を指定。IDは管理画面の「組織/グループ管理」で確認可
  'wordkye'=>7,
];

//戻り値例
{"result":"\u30b9\u30da\u30eb\u30c1\u30a7\u30c3\u30af\u7528\(以下略)}]
//デコード→スペルチェック用の単語を削除しました。

modeのオプション:ルールのタイプ

word: 単語 詳細
wordhinshi: 単語(品詞指定) 詳細
2word: 2単語 詳細
2wordhinshi: 2単語(品詞指定) 詳細
2wordback: 2単語(後方一致) 詳細
3word: 3単語 詳細
kakariuke: 係り受け関係 詳細
cancel: 単語キャンセル 詳細
2cancel: 2単語キャンセル 詳細
phrase: フレーズ 詳細

ルールの詳細:word

keyword: 対象語(必須)20文字まで
correct: 修正語(必須)40文字まで
comment: コメント(任意)400文字まで

ルールの詳細:wordhinshi

keyword: 対象語(必須)20文字まで
correct: 修正語(必須)40文字まで
key_hinshi: 対象語の品詞(必須)名詞、動詞、形容詞、助詞、助動詞、副詞、接続詞、連体詞から選択
comment: コメント(任意)400文字まで
autovar: 活用形を自動生成(任意)オンにする場合は'autovar'を指定

ルールの詳細:2word

keyword: 単語(前)(必須)20文字まで
nkeyword: 単語(後)(必須)20文字まで(正規表現使用可)
comment: コメント(任意)400文字まで
autovar: 活用形を自動生成(任意)オンにする場合は'autovar'を指定

ルールの詳細:2wordhinshi

keyword: 単語(前)(必須)20文字まで
key_hinshi: 単語(前)の品詞(必須)名詞、動詞、形容詞、助詞、助動詞、副詞、接続詞、連体詞から選択
nkeyword: 単語(後)(必須)20文字まで(正規表現使用可)
nkey_hinshi: 単語(後)の品詞(任意)名詞、動詞、形容詞、助詞、助動詞、副詞、接続詞、連体詞から選択
comment: コメント(任意)400文字まで
autovar: 活用形を自動生成(任意)オンにする場合は'autovar'を指定

ルールの詳細:2wordback

pkeyword: 単語(前)(必須)20文字まで(正規表現使用可)
keyword: 単語(後)(必須)20文字まで
comment: コメント(任意)400文字まで

ルールの詳細:3word

keyword: 単語(前)(必須)20文字まで
keyhinshi: 単語(前)の品詞(任意)名詞、動詞、形容詞、助詞、助動詞、副詞、接続詞、連体詞から選択
key2: 単語(中)(必須)20文字まで(正規表現使用可)
key2hinshi: 単語(中)の品詞(任意)名詞、動詞、形容詞、助詞、助動詞、副詞、接続詞、連体詞から選択
key3: 単語(後)(必須)20文字まで(正規表現使用可)
key3hinshi: 単語(後)の品詞(任意)名詞、動詞、形容詞、助詞、助動詞、副詞、接続詞、連体詞から選択
comment: コメント(任意)400文字まで

ルールの詳細:kakariuke

keyword: 単語(係る)(必須)20文字まで
uke: 単語(受ける)(必須)20文字まで(正規表現使用可)
comment: コメント(任意)400文字まで
autovar: 活用形を自動生成(任意)オンにする場合は'autovar'を指定

ルールの詳細:cancel

keyword: 対象語(必須)20文字まで
key_hinshi: 対象語の品詞(任意)名詞、動詞、形容詞、助詞、助動詞、副詞、接続詞、連体詞から選択
autovar: 活用形を自動生成(任意)オンにする場合は'autovar'を指定

ルールの詳細(cancel)

keyword: 単語(前)(必須)20文字まで
key_hinshi: 単語(前)の品詞(任意)名詞、動詞、形容詞、助詞、助動詞、副詞、接続詞、連体詞から選択
nkeyword: 単語(後)(必須)20文字まで(正規表現使用可)
nkey_hinshi: 単語(後)の品詞(任意)名詞、動詞、形容詞、助詞、助動詞、副詞、接続詞、連体詞から選択
autovar: 活用形を自動生成(任意)オンにする場合は'autovar'を指定

ルールの詳細:phrase

keyword: フレーズ(必須)25文字まで
correct: 修正例(必須)100文字まで

APIの呼び出し

以降で実際のAPI呼び出し方法の詳細を説明します。閲覧にはPRUV Businessのアカウントが必要です。PRUV Businessユーザーの方はログインしてください。

  • 利用規約
  • プライバシーポリシー
  • 特定商取引法に基づく表記
  • 主な機能(共通)
  • 主な機能(エディション別)
  • PRUV Pro 5つのポイント
  • PRUV Business 5つのポイント
  • お問い合わせ
  • FAQ
  • 開発ブログ

copyright © 2016-2025 PRUV, All rights reserved.