">mixi Developer Center (mDC)

mixi Page Apps

mixi Page Apps (English) » Technical specification » Mobile UserFlowAPI

Mobile UserFlowAPI

Mobile mixi page apps can use the UserFlowAPI to aid in application development.

This API provides following functions:

Function name Value
User authorization Function to display the dialog window to obtain OAuth 2.0 authorization from users.
External site navigation Function which creates a link for navigation to an external site

User authorization

To transition from the mobile mixi page app to the user authorization view, add the auth:graphapi attribute to the form tag. Only the POST method is supported.
More specifically, write the action attribute for the form tag in HTML as follows:

auth:graphapi

Specify the following parameters as hidden form field values.

Parameter name Value
response_type   "code"
scope This string enumerates the scopes you want to authorize as a space delimited string.
state The value you want to maintain until after the authorization.
※If there are any essential values you want to keep as session values, specify them in this parameter. These values will be included in the redirect after the user's authorization.

An example is as follows.

<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="perform an authorization" />
</form>

If the user agrees, they will be redirected through the Proxy to RedirectURL.
RedirectURL contains the authorization code required for authentication as a query parameter.

Navigation to an external site

This feature will generate a link that navigates to an external site from a mixi page app.
By using this feature, you can direct the user to any external site.
Mixi's bridge page will be shown during all navigations to external sites.

To use this feature, specify the link address as below:

link:external?url=[escaped URL]
Parameter name Value
url Escaped URL of external site you would like user to navigate to.

An example is as follows.

<a href="link:external?url=http%3a%2f%2fexample%2ecom">External Page</a>

TOP OF THIS PAGE