はじめに

ブラウザ上でCOTOHA APIを試すまでのやり方です。
アクセストークンの取得とAPIの実行までの超基本ガイドです。

投稿のきっかけ

はじめまして。COTOHA APIのPR担当をしています。
先日COTOHA APIをリリースしたため、エンジニアではない私ですが、言語処理やAPIの理解のため、自分自身でも利用できるようになりたいとおもいました。
ただ、技術に疎い私には、試してみるまでのハードルがかなり高いです。

まずはブラウザ上でCOTOHA APIを利用できるように、RESTClient上でCOTOHA APIにアクセスできるようになるまでの道のりを丁寧に教えてもらったので、その方法をアップします。

章立て

章立ては、↓のとおりです。

1. REST Clientをインストールする
 2. COTOHA APIにログインする
 3. REST Clientでアクセストークンを取得する
 4. COTOHA APIを実行する

キャプチャをたくさん貼っていたら、けっこう長くなってしまいました。
実際の作業は5分くらいで利用できるようになると思いますので、さくっと試してみてください！

1.REST Clientをインストールする

まずは、REST APIを利用できるRESTクライアントソフトウェアをWEBブラウザの拡張機能として準備します。

ここではFirefoxを利用しました。

こちらにアクセスしてください。
クリックすると、さっそくダウンロード画面です。

「+Firefoxへ追加」をクリックすると、
「1個のアドオンをダウンロードして検証しています」とダウンロードがはじまります。

10秒ぐらいで、検証完了します。

「このサイトはFirefoxに1個のアドオンのインストールを求めています」とインストールの承認

画面がでてきます。
ここで「インストール」を選択します。

すると、3秒くらいで「REST Clientがインストールされました」とのこと。
インストールされるとヘッダーにREST Clientのアイコンが表示されます。
（赤バックにゴールドの太陽マークです）

このREST Clientのアイコンをクリックすると、無事にREST Client画面が表示されました。

※ちなみに、REST Clientマークが表示されない場合は、アドオンが「無効」になっている可能性があります。その場合は、ブラウザのヘッダーにあるメニュー(三本の横線マーク)から「アドオン」を選択して、「アドオンマネージャー」画面を開いてください。

ここで、REST Clientが有効化しているか確認してください。「有効化」というボタンが表示されていたら、無効化されているため、「有効化」ボタンをクリックします。

2. COTOHA APIにログインする

COTOHA APIを試すためにAPI Keyを取得します。
COTOHA APIのfor Developersに会員登録すれば、無償でAPI keyが発行されます。
無償でも各API毎に1000コール/日利用できます。
会員登録は、こちらから。

さて、ログイン後の画面です。

ご覧のとおり、

・Developer API Base URL

・Developer Client id

・Developer Client secret

・Access Token Publish URL

がアカウントホームに掲載されています。

こちらを利用してCOTOHA APIにアクセスします。

3. REST Clientでアクセストークンを取得する

API Keyを手元で確認しつつ、REST Client画面で作業を進めます。

まずは、REST Client画面上のRequestの”Method”で「Post」を選択。

次に”Method”の隣のURL入力画面に、COTOHA APIのアカウントホームに表示されている「Access Token Publish URL」を入力します。

入力しました。↓

次に注目は、REST Clientの画面上部のHeadersです。
クリックすると、「Customer Header」と「Clear Favorites」のタブがでてくるので、「Customer Header」をクリック。

すると、こんな画面が表示されます。

ここに、それぞれ、以下の赤字のテキストをそのまま入力します。
Nameには、「Content-Type」、Attribute Valueには「application/json」です。

Name: Content-Type
Attribute Value: application/json

※オートコンプリート機能が効くかと思いますので、途中で選択してください。
入力したら、「Okay」をクリックします。

Headersに「Content-Type:application/json」と追加されました。

次に、Bodyに以下を入力します。

{
  "grantType":"client_credentials",
  "clientId": "ログイン後の画面に表示されるClient ID",
  "clientSecret": "ログイン後の画面に表示される Client Secret"
}

最後の「}」を忘れないでくださいね。

入力しました。
ようやくこれでインプットは終わりです。
赤い「SEND」ボタンをクリックしてください。

クリックすると・・・
こんな感じです↓

こちらのResponseの「Response」タブにお目当てのアクセストークンが出力されています。
「Response」タブをクリックしてください。

「access_token」がありました！

ようやくアクセストークンをゲットできました！
アクセストークンは後で利用するので、どこかにメモっておいてください。

※アクセストークンは、”access_Token”:のあと、「”」で囲まれている文字列(文字列のみ)です。
※アクセストークンの有効期限は一日のため、24時間経過したら再取得が必要ですので、ご注意を！

4. COTOHA APIを実行する

さて、これでようやくブラウザでCOTOHA APIを試せるようになりました。

まずは、COTOHA APIのログイン後画面に戻り、「Developer API Base URL」をチェックします。

そして、「Developer API Base URL」の後に試したいAPI名を追加します。
たとえば、構文解析を試したい場合は、「parse」と追加します。
以下のようになります。
https://[Developer API Base URL]/parse

※以下に各APIのAPI名のみ記載します。(2018年9月時点のAPIになります)
- 固有表現抽出　https://[Developer API Base URL]/ne
- 照応解析　　　https://[Developer API Base URL]/coreference
- キーワード抽出　https://[Developer API Base URL]/keyword
- 類似度算出　　https://[Developer API Base URL]/similarity
- 文タイプ判定　https://[Developer API Base URL]/sentence_type
- ユーザー属性推定　https://[Developer API Base URL]/user_attribute