APIリファレンス

Monappyでは、外部から情報を取得するためのAPIを用意しております。
APIは、高度な利用者の方向けに提供しています。具体的なAPIの利用方法等は、場合によってはサポートいたしかねることがございます。あらかじめご了承の上ご利用ください。

なお、これらのAPIは予告なく変更・削除されることがあります。
また、本APIを利用したことによる損害やAPIのサービスが提供されなかったことによるいかなる損害についても、当サイトは一切責任を負いません。利用者の方の自己責任にてご利用ください。

基本仕様

APIのエンドポイントはhttps://api.monappy.jp/v1/です。
リクエストパラメータは、GETの場合にはURLクエリを、それ以外のメソッドではbodyを利用して送信してださい。
callbackパラメータに関数名を指定することで、JSONPを使用できます。
仕様が変更される度にAPIのバージョン番号が変更されます。現在の最新版はv1です。

レスポンスはJSON/JSONP形式で返されます。 .xml/.json の拡張子付きURLは非推奨となりました。
statusパラメータはリクエストが成功した場合にok、失敗した場合にerrorを返します。
成功した場合はdataパラメータに結果が格納されます。失敗した場合はerrorパラメータにエラーメッセージが格納されます。

レスポンスの例: 
{
    "status": "ok",
    "data": [
        {
        -- snipped --
        }
    ]
}

{
    "status": "error",
    "error": "Not found"
}

公開API

GET /v1/users/get_address

Monappyに登録されているIDからMonacoinアドレスを取得します。
GET https://api.monappy.jp/v1/users/get_address?nickname=monappy

リクエスト

パラメータ 必須 説明 デフォルト値
nickname Monappyに登録されているID

レスポンス

{
    "status": "ok",
    "address": "MNjhTaRcXGQ5ucxTCHeyjQQMccaz1FV28N"
}
パラメータ 説明
address Monacoinアドレス

GET /v1/users/get_nickname

他の情報からMonappyのIDを取得します。該当するユーザが存在しなければエラーを返します。
現在はTwitterユーザ名からの取得に対応しています。
GET https://api.monappy.jp/v1/users/get_nickname?twitter_id=_monappy_

リクエスト

パラメータ 必須 説明 デフォルト値
twitter_id Twitterのユーザ名

レスポンス

{
    "status": "ok",
    "nickname":"monappy",
    "address": "MNjhTaRcXGQ5ucxTCHeyjQQMccaz1FV28N"
}
パラメータ 説明
nickname MonappyのID
address Monacoinアドレス

GET /v1/picture_places

ピクプレの投稿一覧を取得します。

リクエスト

GET https://api.monappy.jp/v1/picture_places?max=3&offset=5&category_id=0
パラメータ 必須 説明 デフォルト値
offset 取得を開始する地点のオフセット 0
max 最大取得件数(max: 30) 30
author 投稿者のユーザー名 指定なし
category_id カテゴリ
0 - イラスト
1 - 漫画
2 - 写真		 指定なし

レスポンス

{
    "status": "ok",
    "data": [
        {
            "id": "3",
            "name": "手羽先",
            "description": "macbookのトラックパッドで頑張って描いた手羽先！",
            "creator": "_tebasaki",
            "url": "https://monappy.jp/picture_places/view/3",
            "image_url": "https://monaffy.jp/img/picture_place/original/3.png",
            "category_id": "0",
            "received_mona": "1.14114000",
            "comments": "0",
            "view": "526",
            "r18": false,
            "created_at": "2015-03-19T22:33:11+00:00"
        },
        {
            "id": "2",
            "name": "珠ちゃん！",
            "description": "新機能っぽいので試してみる！",
            "creator": "WakiyamaP",
            "url": "https://monappy.jp/picture_places/view/2",
            "image_url": "https://monaffy.jp/img/picture_place/original/2.png",
            "category_id": "0",
            "received_mona": "8.80114000",
            "comments": "0",
            "view": "526",
            "r18": false,
            "created_at": "2015-03-19T22:31:27+00:00"
        },
        {
            "id": "1",
            "name": "テストむきゅー",
            "description": "むっきゅーっ！",
            "creator": "palon7",
            "url": "https://monappy.jp/picture_places/view/1",
            "image_url": "https://monaffy.jp/img/picture_place/original/1.png",
            "category_id": "0",
            "received_mona": "20.37028000",
            "comments": "7",
            "view": "579",
            "r18": false,
            "created_at": "2015-03-19T22:28:29+00:00"
        }
    ]
}
パラメータ 説明 備考
id ピクプレのID
name 投稿のタイトル
description 投稿の説明文
creator 投稿者のユーザー名
url ピクプレのURL
image_url 投稿画像のURL
category_id カテゴリ 0 - イラスト
1 - 漫画
2 - 写真
received_mona 投稿に送られたMONA
comments 投稿のコメント数
view 投稿の閲覧数
r18 R-18フラグ
created_at 投稿日時(ATOM形式)

GET /v1/memo_logs

メモログの投稿一覧を取得します。

リクエスト

GET https://api.monappy.jp/v1/memo_logs?offset=0&max=3&author=monappy
パラメータ 必須 説明 デフォルト値
offset 取得を開始する地点のオフセット 0
max 最大取得件数(max: 30) 30
author 投稿者のユーザー名 指定なし

レスポンス

{
    "status": "ok",
    "data": [
        {
            "id": "178",
            "name": "tipmona連携機能ともなっぴドン送金通知機能が追加！",
            "creator": "monappy",
            "theme": "",
            "paid": false,
            "price": null,
            "currency": "0",
            "description": null,
            "url": "https://monappy.jp/memo_logs/view/monappy/178",
            "received_mona": "0.00115115",
            "comments": "2",
            "view": "866",
            "r18": false,
            "created_at": "2017-06-23T08:01:10+00:00"
        },
        {
            "id": "173",
            "name": "ViewerがMixerに対応、連携も追加",
            "creator": "monappy",
            "theme": "",
            "paid": false,
            "price": null,
            "currency": "0",
            "description": null,
            "url": "https://monappy.jp/memo_logs/view/monappy/173",
            "received_mona": "0.00114114",
            "comments": "0",
            "view": "308",
            "r18": false,
            "created_at": "2017-06-19T18:37:45+00:00"
        },
        {
            "id": "166",
            "name": "モナキャラまとめ",
            "creator": "monappy",
            "theme": "",
            "paid": false,
            "price": null,
            "currency": "0",
            "description": null,
            "url": "https://monappy.jp/memo_logs/view/monappy/166",
            "received_mona": "3.28342116",
            "comments": "1",
            "view": "661",
            "r18": false,
            "created_at": "2017-06-17T02:00:41+00:00"
        }
    ]
}
パラメータ 説明 備考
id メモログのID
name 投稿のタイトル
creator 投稿者のユーザー名
url メモログのURL
theme 投稿テーマ 互換性のために常に空文字列を返す
paid 有料フラグ 0 - 無料
1 - 有料
price 価格（有料のみ）
currency 価格の通貨 0 - MONA
1 - JPY
description 投稿の説明（有料の場合のみ）
received_mona 投稿に送られたMONA
comments 投稿のコメント数
view 投稿の閲覧数
r18 R-18フラグ
created_at 投稿日時(ATOM形式)

GET /v1/payments

ペイメントの投稿一覧を取得します。

リクエスト

GET https://api.monappy.jp/v1/payments?offset=0&max=3&author=palon7
パラメータ 必須 説明 デフォルト値
offset 取得を開始する地点のオフセット 0
max 最大取得件数(max: 30) 30
author 投稿者のユーザー名 指定なし

レスポンス

{
    "status": "ok",
    "data": [
        {
            "id": "432",
            "name": "【Steamウォレットコード】 500円分",
            "description": "Steamで使える500円分のウォレットコードです。\r\nゲームの購入などに使用できます。",
            "creator": "palon7",
            "url": "https://monappy.jp/checkout/palon7-Elg0JUg",
            "price": "495.00000000",
            "price_currency": "1",
            "category": "2",
            "in_stock": false,
            "stock": "0",
            "r18": false,
            "created_at": "2015-03-19T19:07:21+00:00"
        },
        {
            "id": "255",
            "name": "【Amazonギフト券】500円分",
            "description": "Amazon.co.jpで使えるギフト券です。\r\n金額: 500円\r\n有効期限: 2016/01/27",
            "creator": "palon7",
            "url": "https://monappy.jp/checkout/palon7-YSlTNBA",
            "price": "500.00000000",
            "price_currency": "1",
            "category": "2",
            "in_stock": false,
            "stock": "0",
            "r18": false,
            "created_at": "2015-01-27T19:56:24+00:00"
        },
        {
            "id": "226",
            "name": "【東方アレンジ】Rosa sororum",
            "description": "https://soundcloud.com/palon/rosa-sororum-xfd\r\n\r\nhttp://rgne0001.tumblr.com/\r\n秋季例大祭で頒布した東方アレンジCDです。\r\nこちらの商品はダウンロード販売となります。\r\n\r\n01. Rosa sororum -  魔法少女達の百年祭 / U.N.オーエンは彼女なのか？\r\n02. Stella puella -  ほおずきみたいに紅い魂 / 妖魔夜行\r\n03. Tick -  月時計　～ ルナ・ダイアル\r\n04. Dark room (2014 Remix) - U.N.オーエンは彼女なのか？\r\n\r\n購入後、URLが表示されますのでそちらのページで指示に従ってダウンロードをお願いします。",
            "creator": "palon7",
            "url": "https://monappy.jp/checkout/palon7-FkiVNAY",
            "price": "400.00000000",
            "price_currency": "1",
            "category": "1",
            "in_stock": true,
            "stock": null,
            "r18": false,
            "created_at": "2015-01-03T02:44:40+00:00"
        }
    ]
}
パラメータ 説明 備考
id ペイメントのID
name 商品名
creator 販売者のユーザー名
url ペイメントのURL
price 価格
currency 価格の通貨 0 - MONA
1 - JPY
category カテゴリ 0 - 物販
1 - データ
2 - 金券
3 - 暗号通貨
4 - その他
in_stock 在庫状況 true - 在庫あり
false - 在庫なし
stock 在庫
description 商品の説明
r18 R-18フラグ
created_at 投稿日時(ATOM形式)

その他の機能

送金画面

ユーザー名を指定して送金画面を開くことが出来ます。デフォルトの金額・メッセージ・通貨をオプションとして指定できます。
https://monappy.jp/users/send/@monappy?amount=0.114114&currency=0

オプション

パラメータ 説明 備考
amount 金額
message メッセージ
currency 通貨 0 - MONA
1 - JPY

サンプル

Javascript
openSendWindow = function(user, amount, message, currency) {
  url = 'https://monappy.jp/users/send/@' + user + '?';
  if (amount) {
    url = url + 'amount=' + amount;
  }
  if (message) {
    url = url + '&message=' + encodeURIComponent(message);
  }
  if (currency) {
    url = url + '&currency=' + currency;
  }
	window.open(url,"window","width=600,height=410");
  return false;
}
HTML
<a href="#" onclick='openSendWindow("monappy", "0.114114", "こんにちは！", "0")'>Open</a>