Skip to content

Instantly share code, notes, and snippets.

@baseinc
baseinc / base_api_v1.md
Last active December 23, 2020 05:24

BASE API v1 ドキュメント (β版)

BASEのAPIの開発者向けのドキュメントです。

概要

このAPIを使うと、あなたのアプリケーションとBASEを連携させることができます。

例えば

  • BASEのアカウントでログインする
  • BASEのショップの商品情報を取得する
@baseinc
baseinc / base_api_v1_users_me.md
Last active August 29, 2015 13:57

GET /1/users/me

ユーザー情報を取得

scope

read_users (メールアドレスも取得したい場合はread_users_mail)

リクエストパラメーター

@baseinc
baseinc / base_api_v1_orders.md
Last active August 29, 2015 13:57

GET /1/orders

注文情報の一覧を取得

scope

read_orders

リクエストパラメーター

@baseinc
baseinc / base_api_v1_oauth_authorize.md
Last active August 29, 2015 13:57

GET /1/oauth/authorize

認可コードを取得

  1. クライアント側でこのURLへユーザーを遷移させるリンクを作成してください。
  2. ユーザーがBASE側へ遷移すると認証画面が表示されます。
  3. ユーザーがクライアントとの連携を許可した場合、コールバックURLに認可コードを付与してリダイレクトさせます。

リクエストパラメーター

@baseinc
baseinc / base_api_v1_oauth_access_token.md
Last active August 29, 2015 13:57

POST /1/oauth/token

認可コードからアクセストークンを取得

アクセストークンの有効期限は1時間程度です。

リクエストパラメーター

Name Description
@baseinc
baseinc / base_api_v1_oauth_refresh_token.md
Last active August 29, 2015 13:57

POST /1/oauth/token

リフレッシュトークンからアクセストークンを取得

アクセストークンは有効期限が短いのでリフレッシュトークンを頻繁に利用することになります。

リフレッシュトークンの有効期限は30日程度です。

リクエストパラメーター

@baseinc
baseinc / base_api_v1_items.md
Last active August 29, 2015 13:57

GET /1/items

商品情報の一覧を取得

scope

read_items

リクエストパラメーター

@baseinc
baseinc / base_api_v1_items_detail.md
Last active August 29, 2015 13:57

GET /1/items/detail/:item_id

商品情報を取得

scope

read_items

リクエストパラメーター

@baseinc
baseinc / base_api_v1_orders_detail.md
Last active August 29, 2015 13:58

GET /1/orders/detail/:unique_key

注文情報を取得

scope

read_orders

リクエストパラメーター

@baseinc
baseinc / base_api_v1_orders_edit_status.md
Last active August 29, 2015 13:58

POST /1/orders/edit_status

注文情報のステータスを更新

ステータスは3種類あります。

  • ordered (未発送)
  • dispatched (発送完了)
  • cancelled (キャンセル済み)