「よみたんAPI」使用方法

「よみたんAPI」はWeb APIとなっています。
基本的には、
https://yomitan.harmonicom.jp/api/v2/yomi
に、GETリクエストでクエリーを渡すことで、読みがなが帰ってくるようなしくみです。

たとえば上記のURLにアクセスすると、UTF-8で「かんじ」と読みがなを返します。

クエリストリング

「ic」クエリーは入力文字コード、「oc」クエリーは出力文字コードが入ります。 文字コードは「UTF8」「EUCJP」「SJIS」「JIS」が使えます。デフォルトはUTF8です。
「kana」クエリーに「h」を入れるとひらがな、「k」を入れるとカタカナを返します(無指定だとひらがなが出ます)。
「text」クエリーには、変換したい漢字等が入ります。変換したい漢字等は、URLエンコード(%AD%E3のような形式)にしてください。
「num」クエリーには読み方の候補として出力する数を指定します。出力は「,」(カンマ)を区切りとして複数出力されます。ただし、読み方のパターンが存在しない場合、指定種類出力されないこともあります。

レスポンス

レスポンスはJSON形式で帰ります。

{
  "encode": "UTF8",
  "text": "読めない字",
  "yomi": [
    "よめないじ",
    "よめないあざ"
  ]
}

「encode」には出力文字コードが入ります。
「text」には変換したい元の文字列が入ります。
「yomi」には読み方が入ります。配列になっており、指定した出力数分用意されます。

出力結果については、改行コードやtabコード、半角記号のほとんどが消去されます。
また、半角英字はすべて小文字に変換されます。
ローマ字読みできる英字は読み仮名に変換されます。

説明

形態素解析エンジン「MeCab(和布蕪)」を使って読み仮名を取り出し表示しています。
APIなので外部から呼び出して使うこともできます。

辞書はIPA辞書を使っています。
ただ、IPA辞書には難しい漢字や人名、スラングなどはあまり登録されていないようです。
そこで、検索ログを見てて誤変換していそうな漢字があったときは、手作業でMeCabのユーザー辞書追加に追加しています。
英単語などの読み方も追加で登録しています。

「よみたんAPI」ご利用規約

「よみたんAPI」をWebサイトやアプリケーション上でお使いになる際は、以下の点にご留意ください

• 当「よみたん」と同様のサービスに転用することはお断りいたします。
• 原則として、無料でご利用いただけます。
• ただし、今後有料化される可能性はあります。
• Webサイトなどでご利用の場合は、「よみたんAPI」を使用していることを明記してください。
• 当「よみたん」サイトの使用は無料です。

• ※上記を遵守いただけない場合は、アクセス制限をかけることがあります。