認可

リアルタイムAPIではトークンにより認可が行われます。以下の3種類のトークンのいずれかを使用してください。

  • OAuth2のアクセストークン

    REST APIで取得したOAuth2のアクセストークンを使用できます。トークンの取得方法については、 ユーザーのOAuth2クライアントを使う を参照してください。

  • iSCPチケット

    iSCPチケットと呼ばれるトークンも使用できます。 iSCPチケットとは、REST APIの POST /iscp/tickets で取得できるトークンで、主にウェブブラウザー上で動作するアプリケーションでの使用が想定されています。 チケットの有効期限は数秒間です(サーバーアプリケーションの設定による)。同じチケットを2回以上使用することはできません。

  • ユーザーのAPIトークン

    ユーザーの My Page で発行されたAPIトークンを使用することができます。

リアルタイムAPI用ライブラリを使用する際には、トークンソースとして、これらのトークンのいずれかを返す関数を指定してください。

例えば、Python用ライブラリiscp-pyの場合、 iscp.Conn.connect()メソッド の引数 token_source で、上記3種のトークンいずれかを返す関数を指定してください。リアルタイムAPIの接続のたびにこの関数がコールされ、得られたアクセストークンが使用されます。

各言語別ライブラリでのトークンソースの指定方法については、ライブラリのドキュメントおよびコードサンプルを参照してください。

注釈

リアルタイムAPIでの認可は、 iSCPの拡張仕様 を使用しています。