API docs by Redocly

Furupura Admin API (1.0.0)

Download OpenAPI specification:

Furupura API Team: api@furupura.jp

ふるぷら管理者向けAPI

← API Portal に戻る

auth

管理者認証

管理者ログイン

管理者アカウントでログインします。MFA対応。

Request Body schema: application/json
required
email
required
string <email>
password
required
string <password>
mfa_code
string^\d{6}$

二要素認証コード

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "password": "pa$$word",
  • "mfa_code": "string"
}

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "refresh_token": "string",
  • "expires_in": 0,
  • "admin": {
    }
}

users

ユーザー管理

ユーザー一覧取得

システム内のユーザー一覧を取得します。ステータスや登録日でフィルタリング可能です。

Authorizations:
bearerAuth
query Parameters
page
integer >= 1
Default: 1

ページ番号

per_page
integer [ 1 .. 100 ]
Default: 20

1ページあたりの件数

q
string

検索キーワード

status
string
Enum: "active" "suspended" "deleted"
created_from
string <date>
created_to
string <date>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

ユーザー詳細取得

指定したユーザーの詳細情報を取得します。

Authorizations:
bearerAuth
path Parameters
userId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com",
  • "name": "string",
  • "phone": "string",
  • "status": "active",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_login_at": "2019-08-24T14:15:22Z",
  • "addresses": [
    ],
  • "order_count": 0,
  • "total_spent": 0,
  • "notes": "string"
}

ユーザー情報更新

ユーザーのステータスやメモを更新します。

Authorizations:
bearerAuth
path Parameters
userId
required
string
Request Body schema: application/json
required
status
string
Enum: "active" "suspended"
notes
string <= 1000 characters

Responses

Request samples

Content type
application/json
{
  • "status": "active",
  • "notes": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com",
  • "name": "string",
  • "phone": "string",
  • "status": "active",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_login_at": "2019-08-24T14:15:22Z",
  • "addresses": [
    ],
  • "order_count": 0,
  • "total_spent": 0,
  • "notes": "string"
}

shops

ショップ管理

ショップ一覧取得

システム内のショップ一覧を取得します。ステータスでフィルタリング可能です。

Authorizations:
bearerAuth
query Parameters
page
integer >= 1
Default: 1

ページ番号

per_page
integer [ 1 .. 100 ]
Default: 20

1ページあたりの件数

q
string

検索キーワード

status
string
Enum: "active" "pending" "suspended"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

analytics

分析・レポート

ダッシュボード統計取得

売上、注文、ユーザー、ショップの統計情報を取得します。

Authorizations:
bearerAuth
query Parameters
period
string
Default: "month"
Enum: "today" "week" "month" "year"

Responses

Response samples

Content type
application/json
{
  • "period": "today",
  • "sales": {
    },
  • "orders": {
    },
  • "users": {
    },
  • "shops": {
    }
}

system

システム管理