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

PRUV APIサービス

PRUVの校正機能を外部サイトに提供するAPIです。利用者側の開発が必要ですが、お使いのCMSやブログのエディタなどに組み込むことが可能です。

APIを使うには、管理画面で若干設定を行う必要があります。また設定できるのは組織管理者のみです。

「組織/グループ管理」でAPIサービスを「使用する」にします。

画面1 デフォルトは「使用しない」

画面1 デフォルトは「使用しない」

この時点でAPIの呼び出しが可能です。

画面2 「使用する」にした画面

画面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チェック(モデルを1つ指定)※一部の組織にのみ提供中
LSTM
Transformer
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:い抜き言葉をチェックしない
CharCount: 文字数カウンター使用時「checked」
NameYure: 名前ゆれチェック使用時「checked」
textlint: textlint使用時「checked」

管理画面で設定した「SSLキー(秘密鍵)」は送信しないことに注意してください。これらを「&」でつないでURLを構築します。以下は一例です。

?id=ユーザーID&pass=パスワード&usessl=off&sentence=今日は日曜日だ

なお、利用規約の通りユーザーIDを共有することはできません。APIを利用する人数分のユーザーIDを取得してください。1日に使えるリクエスト数はユーザーごとに制限があります。足りない場合はユーザーアカウントを追加してください。

APIの呼び出し

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

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

copyright © 2016-2023 PRUV, All rights reserved.