">mixi Developer Center (mDC)

mixi Connect

mixi Connect (English) » mixi Plugin » Favorite Button » Specification

Specification

Favorite Button (for PC)

Developers (“you”) can add the following iframe elements to place a favorite button on websites.

<iframe src="http://plugins.mixi.jp/favorite.pl?href=...&service_key=..."
            scrolling="no"
            frameborder="0"
            allowTransparency="true"
            style="border:0; overflow:hidden; width:450px; height:80px;"></iframe>
src Attribute

The URL to be specified for src attribute:

http://plugins.mixi.jp/favorite.pl?

As a query parameter, you can specify followings:

href URL to be placed a favorite button Mandatory
service_key check key to be registered on mixi Partner Dashboard Mandatory
width Width for a favorite area (pxl). Default setting: 450pxl
show_faces “true” in the case you intend to show user’s profile image

Assuming, “http://example.com/index.html” is a website, check key is “0123456789ABC”, and profile image is shown in the favorite area, iframe elements should be described as follows:

<iframe src="http://plugins.mixi.jp/favorite.pl?href=http%3A%2F%2Fexample.com%2Findex.html&service_key=0123456789ABC&show_faces=true"
            scrolling="no"
            frameborder="0"
            allowTransparency="true"
            style="border:0; overflow:hidden; width:450px; height:80px;"></iframe>

The URL and each parameter in src attribute should be escaped properly.

scrolling, frameborder, allowTransparency Attributes

You can use these attribute as described in the sample code above.

style Attribute

style attribute can be set up freely. For the favorite area, you can refer to guidelines:

  • Width should be same pixel as you specify for src attribute.
  • Height should be more than 80 pxl to show the profile image. Otherwise, 20 pxl is required.

How to Specify Description, Thumbnail Images for Favorite

Titles, descriptions and/or thumbnail imanges shown on mixi when a user click a favorite button can be specified. You can refer to how to specify them in technical specification for mixi check.

TOP OF THIS PAGE