API docs by Redocly

Furupura User API (1.0.0)

Download OpenAPI specification:

Furupura API Team: api@furupura.jp

ふるぷらユーザー向けAPI

← API Portal に戻る

auth

認証

ユーザー登録

新規ユーザーアカウントを作成します。

Request Body schema: application/json
required
email
required
string <email>
password
required
string <password> >= 8 characters
name
required
string <= 100 characters
phone
string^\d{10,11}$

Responses

Request samples

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

Response samples

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

ログイン

メールアドレスとパスワードでログインします。

Request Body schema: application/json
required
email
required
string <email>
password
required
string <password>

Responses

Request samples

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

Response samples

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

profile

プロフィール管理

プロフィール取得

ログイン中のユーザーのプロフィール情報を取得します。

Authorizations:
bearerAuth

Responses

Response samples

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

プロフィール更新

プロフィール情報を部分的に更新します。

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
string <= 100 characters
phone
string^\d{10,11}$

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "phone": "string"
}

Response samples

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

browsing

商品閲覧

商品一覧取得（公開商品のみ）

公開されている商品の一覧を取得します。カテゴリや価格帯でフィルタリング可能です。

query Parameters
page
integer >= 1
Default: 1

ページ番号

per_page
integer [ 1 .. 100 ]
Default: 20

1ページあたりの件数

q
string

検索キーワード

category
string
min_price
integer
max_price
integer

Responses

Response samples

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

cart

カート管理

カート内容取得

現在のカートの内容を取得します。

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total_amount": 0,
  • "item_count": 0,
  • "estimated_tax": 0
}

カートに商品追加

指定した商品をカートに追加します。

Authorizations:
bearerAuth
Request Body schema: application/json
required
product_id
required
string
quantity
required
integer >= 1

Responses

Request samples

Content type
application/json
{
  • "product_id": "string",
  • "quantity": 1
}

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total_amount": 0,
  • "item_count": 0,
  • "estimated_tax": 0
}

checkout

購入手続き