チャネルトークのOpen APIを使用するにあたって、その準備となるAPI Keyを発行・利用する方法について紹介します

  1. "Access Key"と"Access Secret"を発行
  2. 要請が正常に反映されるのかswaggerを利用してテスト・APIを実際に利用

👇 こちらにも詳しいドキュメントがあります

https://developers.channel.io/docs/what-is-open-api

  1. "API認証および管理"タブを開き、新しい認証キーを作成をクリック

    https://s3-us-west-2.amazonaws.com/secure.notion-static.com/10167ec5-8d67-4132-96bc-e66da410ce4f/_2020-03-13_3.21.53.png

  2. 任意のAPI認証キーの名前をつけると、このように"Access Key"と"Access Secret"が発行されます

    https://s3-us-west-2.amazonaws.com/secure.notion-static.com/47948354-a6ca-45d4-9991-6f379a7cd24c/_2019-08-18_15.02.25.png

  3. チャネルトークのAPIツール(Swagger)に移動します

https://api-doc.channel.io/

https://s3-us-west-2.amazonaws.com/secure.notion-static.com/fe336b0b-7cd5-45df-93fd-223c2e9139ea/_2020-03-24_18.55.40.png

4. 認証の準備

右上の"Key"と"Secret"の入力欄にそれぞれ先ほど発行した"Access Key"と"Access Secret"をペーストしてください

https://s3-us-west-2.amazonaws.com/secure.notion-static.com/66ea53c4-0183-45a2-b296-c00066650013/_2020-03-24_18.58.15.png

もし、他のREST API利用サービス(PostmanやAdvanced Rest Client)もしくはHTTP ResquestでAPIにリクエストを送信する際には、Headerに "X-Access-Key" と "X-Access-Secret" に"Access Key"と"Access Secret"をそれぞれ挿入して利用する必要があります。

5. 利用したいOpen APIを見つけ、Try it outをクリックしてください

APIにリクエストを送る準備ができます

https://s3-us-west-2.amazonaws.com/secure.notion-static.com/7d607487-c932-4d08-baf0-048a4dd7a948/_2020-03-24_19.01.10.png

  1. APIのリクエストに必要な情報を入れて、"Execute"を押してください!これで完了です!

https://s3-us-west-2.amazonaws.com/secure.notion-static.com/cf9ff1fb-e33f-4251-914e-30d7672af740/30.gif