Misoca API について

Misoca を外部アプリケーションから利用するためのAPIです。

使い方

前提

アプリケーションの登録

  1. Misoca にログインした状態で、 https://app.misoca.jp/oauth2/applications にアクセスします。
  2. 新しいアプリケーションの登録 ボタンを押下します。これにより「新しいアプリケーションの登録」画面に遷移します。
  3. 次の各項目記入してください。
    • 名称
      • アプリケーションの名称です。任意の名称をつけることが出来ます。利用権限の確認時に表示されます。
    • Callback url
      • OAuth2 利用時のコールバックURLです。ここに挙げられたURL以外へはコールバックできません。改行区切りにて複数行記入することが出来ます。
  4. 更新 ボタンを押下します。 これによりアプリケーション詳細画面に遷移します。
  5. アプリケーション詳細画面では下記の項目が提示されます。各項目を用いて OAuth 認証を行うアプリケーションを開発してください。
    • Application ID
    • Secret
    • Callback URL

認証

OAuth2

認証のエンドポイント

認証には OAuth2.0 を用います。 WebAPI の利用時に Authorization ヘッダに OAuth パラメータを含めて HTTP リクエストを送出します。 ヘッダ内の OAuth トークンによって、Misoca ユーザを識別します。

また、スコープとして read または writeがあり、それぞれのAPIに権限が設定されています。 スコープは read < write の関係にあり、write 権限があれば、読み込みを行うことは出来ます。

トークンの有効期間は90日となっています。必要に応じてリフレッシュを行ってください。

API の利用について

ドキュメント

アップデート・更新履歴

2017年8月1日

2017年9月1日より旧プランではご利用いただけなくなります。新プランへの移行をお願いいたします。

利用契約の移行手続き方法について