mixiページアプリ » 技術仕様 » Mobile UserFlowAPI
Mobile UserFlowAPI
モバイルのmixiページアプリでは、アプリ作成を補助するUserFlowAPIを利用することができます。
本APIが提供する機能は以下の通りです。
| 機能名 | 指定する値 |
|---|---|
| ユーザ認可 | ユーザからOAuth 2.0の認可をもらうためのダイアログを表示する機能 |
| 外部サイト遷移 | 外部サイトに遷移するリンクを作成するための機能 |
ユーザー許可
モバイルのmixiページアプリからユーザ認可画面に遷移するには、formタグにてauth:graphapiという記述を使用します。メソッドはPOSTのみをサポートしています。
具体的には、HTMLのformタグが持つaction属性に以下のように記述します。
auth:graphapi
パラメータには以下を指定します。
| パラメータ名 | 指定する値 |
|---|---|
| response_type | "code" |
| scope | 半角スペースを区切り文字として、認可したいスコープを列挙した文字列 |
| state |
認可後まで持ちまわりたい値 ※セッションを維持するために必要となる値があれば、このパラメータに指定します。ユーザの認可後に行われるリダイレクト時にこの値が含まれます。 |
以下に例を示します。
<form action="auth:graphapi" method="POST"> <input type="hidden" name="response_type" value="code" /> <input type="hidden" name="scope" value="r_profile r_voice w_voice" /> <input type="hidden" name="state" value="1234567890" /> <input type="submit" value="認可を行う" /> </form>
ユーザが同意した場合には、RedirectURLにProxyを介して遷移します。
RedirectURLには認可に必要なcodeパラメータも付加されます。
外部サイト遷移
mixiページアプリから、外部サイトに遷移するリンクを生成する機能です。
この機能を用いることで、ユーザを任意の外部サイトに誘導することができます。
遷移時にはmixiのブリッジページを必ず挟むことになります。
この機能を利用するには、リンク先のアドレスに以下を指定します。
link:external?url=[エスケープ済みURL]
| パラメータ名 | 指定する値 |
|---|---|
| url | 遷移したい外部サイトのエスケープ済みURL |
以下に例を示します。
<a href="link:external?url=http%3a%2f%2fexample%2ecom">外部ページへ</a>