">mixi Developer Center (mDC)

mixi Page Apps

mixi Page Apps (English) » Technical specification » Page App API

Page App API

The Page App API is an API for the developer and administrator of mixi page apps. You can get mixi page app information about your own mixi page app. The page app API is a part of the mixi Graph API just like the Page API, and mixi page apps can use this API.

 

Prerequisites

You need to obtain the following information prior to using the Page App API.

  • A client authorized access token that is granted for the "r_pagefeed" scope.

You can't access the Page App API using an authorized access token other than the above scope.
Please refer to 'Obtain an Access Token (Client authorization)' in the 'technical specification overview' (http://developer.mixi.co.jp/en/page-apps/spec/summary/#toc-5)

The features and the access token provided in Page App API

The following shows correspondence of the access token you need to use Page App API's features.

Feature Access token
Obtain Page ID where an app is installed Client authorized access token

Obtain Page ID where an app is installed  

Get a Page ID of the app that is accessing to this API is installed.

GET http://api.mixi-platform.com/2/pageapp/pages

Supports the following query parameter.

Parameter Name Value
pageId mixi page's ID. If you want to specify a single page.

Results will be returned in the JSON format as follows.

When you get a list

{
  "entry" : [
    {
      pageId : "100001",
      moduleIds : [
        "100",
        "101",
        "102"
      ]
    },
  ・・・(Omitted)・・・
  ]
};

When you specify a specific page

{
  "entry" : {
    pageId : "100001",
    moduleIds : [
      "100",
      "101",
      "102"
    ]
  }
};

The information is included in each entry is as follows.

Attribute name Description
pageId mixi page's ID
moduleId ID used to discriminate when multiple instances of the same app are installed on the mixi page

Paging

The Page App API supports paging.
Please refer to 'How to specify Paging' (http://developer.mixi.co.jp/en/connect/mixi_graph_api/mixi_io_spec_top/api_common_spec#toc-1)
The default value for the returned result count is 100 per page for this API. The maximum returned result count is 1000 per page.

TOP OF THIS PAGE