microzeny API API Reference

microzeny APIを利用すると、microzenyアカウントを使ってBitZenyの支払いや受け取りを行うことができます。microzenyは仮想通貨の実体ではなく権利のみを移動するオフチェーンサービスのため、支払い・受け取りはAPIリクエスト後すぐに完了します。

支払いは、最初にmicrozenyのウォレットからサービスに対してチャージを行いそのチャージ残高を使ってAPIから自由に支払いが行える ChargePayment、microzenyのウォレットから毎回確認を取りながら直接支払いを行う DirectPayment の2種類の方式があります。 ChargePaymentは、faucetのような特定のアカウントのチャージを複数ユーザに支払う仕組みや、ゲームプレイ料やAPI利用料のように何度も支払いを行うようなユースケースを想定しており、DirectPaymentはECサイトのようにまとまった金額をユーザが明示的に支払うようなサービスを想定しています。

microzeny APIの OpenAPI 定義ファイルは OpenAPI Spec File にて公開しています。

API Endpoint

https://api.microzeny.com/v1

Request Content-Types: application/x-www-form-urlencoded

Response Content-Types: application/json

Schemes: https

Version: 0.0.1

Authentication

microzeny_oauth

type

oauth2

flow

accessCode

authorizationUrl

https://microzeny.com/oauth/authorize

tokenUrl

https://api.microzeny.com/oauth/token

scopes

accounts

認可したmicrozenyアカウントの情報を取得します

charge_payment

サービスにチャージを行ってから支払うChargePayment方式の支払いを行います

Account

microzenyアカウントの情報

Account

microzenyアカウントの情報を取得

GET /accounts

microzenyアカウントの識別ID、名前、プロフィール、プロフィール画像URLを取得します。

200 OK

Account

Success.

Response Example (200 OK)

{
  "id": "acc_xxxxxxxxxx",
  "name": "@microzeny",
  "profile": "microzenyは仮想通貨BitZenyのための決済ポータルサービスです。たくさんのfaucetや誰でも簡単にfaucetを開設できる機能を提供しています。",
  "profile_image_url": "https://pbs.twimg.com/profile_images/968861259843031041/BuA1G1WV.jpg"
}


microzeny_oauth	accounts

ChargePayment

最初にサービスに対してチャージを行ってから支払う方法

ChargePayment

現在の残高を取得

GET /balance

サービス用ウォレットの残高を取得します。

200 OK

Balance

Success.

Response Example (200 OK)

{
  "balance": "100000000",
  "balance_bitzeny": "1.00000000"
}


microzeny_oauth	charge_payment

ChargePayment

サービス用のウォレットに対してチャージを行うURLを作成

POST /charges

サービス用のウォレットに対してチャージを行うためのワンタイムのURLを取得します。

200 OK

Charge

Success.

Response Example (200 OK)

{
  "id": "cha_xxxxxxxx",
  "url": "https://microzeny.com/charges/cha_xxxxxxxx",
  "expired_at": "2018-07-01 00:00:00",
  "status": "waiting",
  "amount": "1.00000000"
}


microzeny_oauth	charge_payment

ChargePayment

IDを指定してチャージの情報を取得

GET /charges/{charge_id}

IDを指定してチャージの情報を取得します。ユーザがチャージURLからコールバックして来た時にチャージの結果を取得するなどに利用します。

charge_id

in path

string

(no description)

200 OK

Charge

Success.

Response Example (200 OK)

{
  "id": "cha_xxxxxxxx",
  "url": "https://microzeny.com/charges/cha_xxxxxxxx",
  "expired_at": "2018-07-01 00:00:00",
  "status": "waiting",
  "amount": "1.00000000"
}


microzeny_oauth	charge_payment

DirectPayment

microzenyのデフォルトのウォレットから直接支払う方法

Schema Definitions

Account: object

id: string: アカウントのID
name: string: アカウントの名前
profile: string: プロフィール文
profile_image_url: string: プロフィール画像のURL

Example

{
  "id": "acc_xxxxxxxxxx",
  "name": "@microzeny",
  "profile": "microzenyは仮想通貨BitZenyのための決済ポータルサービスです。たくさんのfaucetや誰でも簡単にfaucetを開設できる機能を提供しています。",
  "profile_image_url": "https://pbs.twimg.com/profile_images/968861259843031041/BuA1G1WV.jpg"
}

Balance: object

balance: string: 残高の1/100μZNY表記。必ず整数。
balance_bitzeny: string: 残高のZNY表記。小数点以下は最長で8桁。計算を行う際はDecimalとして取り扱う必要があります。

Example

{
  "balance": "100000000",
  "balance_bitzeny": "1.00000000"
}

Charge: object

id: string: チャージのID
url: string (url): チャージを行うためのURL
expired_at: string (datetime): チャージ可能な期限
status: string waiting, charged, canceled, expired: チャージの状態
amount: string: チャージ金額。単位はZNYで小数点以下は最長で8桁。計算を行う際はDecimalとして取り扱う必要があります。

Example

{
  "id": "cha_xxxxxxxx",
  "url": "https://microzeny.com/charges/cha_xxxxxxxx",
  "expired_at": "2018-07-01 00:00:00",
  "status": "waiting",
  "amount": "1.00000000"
}

Documentation by Spectacle