Skip to content
This repository was archived by the owner on Jun 7, 2019. It is now read-only.

Commit 45ed5aa

Browse files
yaakaitoyaakaito
committed
move to docs.thebase.in
1 parent 2760123 commit 45ed5aa

29 files changed

+58
-3841
lines changed

‎README.md

+2-159
Original file line numberDiff line numberDiff line change
@@ -1,160 +1,3 @@
1-
# BASE API v1 ドキュメント (β版)
2-
BASEのAPIの開発者向けのドキュメントです。
1+
このドキュメントは下記のページへ移動しました。
32

4-
## 概要
5-
このAPIを使うと、あなたのアプリケーションとBASEを連携させることができます。
6-
7-
例えば
8-
9-
* BASEのアカウントでログインする
10-
* BASEのショップの商品情報を取得する
11-
* BASEのショップの商品情報を更新する
12-
* BASEのショップの注文情報を取得する
13-
14-
※ APIは順次公開していく予定です。
15-
16-
## 仕様
17-
18-
### エンドポイント
19-
20-
https://api.thebase.in/ 配下に各種APIが用意されています。 (httpsのみ)
21-
22-
### 認証
23-
24-
OAuth2.0に対応
25-
26-
Authorizationヘッダーでアクセストークンを送信して認証します。
27-
28-
```
29-
Authorization: Bearer {Access_Token}
30-
```
31-
32-
リフレッシュトークンも発行しています。
33-
34-
OAuth2.0の仕様については、下記の外部サイトを参照ください。
35-
36-
* http://openid-foundation-japan.github.io/rfc6749.ja.html
37-
* http://openid-foundation-japan.github.io/rfc6750.ja.html
38-
39-
OAuth2.0のclient_idとclient_secretの取得には、BASE Developersへの利用登録と利用許可が必要です。下記URLから申請いただけます。
40-
* https://developers.thebase.in
41-
42-
### scope
43-
44-
* read_users - ユーザー情報を取得 (デフォルトで付与)
45-
* read_users_mail - ユーザーのメールアドレスを取得
46-
* read_items - 商品情報を取得
47-
* read_orders - 注文情報を取得
48-
* read_savings - 振込申請情報を取得
49-
* write_items - 商品情報を更新
50-
* write_orders - 注文情報を更新
51-
52-
### レスポンス
53-
54-
JSON形式でレスポンスを返します。
55-
56-
正常な場合はHTTPステータスコード 200 OKを返します。
57-
58-
エラーの場合はHTTPステータスコード 400 Bad Requestを返します。
59-
60-
エラーレスポンスの例
61-
62-
```
63-
{
64-
"error":"invalid_request",
65-
"error_description":"アクセストークンが無効です。"
66-
}
67-
```
68-
69-
## API
70-
71-
### OAuth
72-
73-
* [GET /1/oauth/authorize](base_api_v1_oauth_authorize.md) - 認可コードを取得
74-
* [POST /1/oauth/token](base_api_v1_oauth_access_token.md) - 認可コードからアクセストークンを取得
75-
* [POST /1/oauth/token](base_api_v1_oauth_refresh_token.md) - リフレッシュトークンからアクセストークンを取得
76-
77-
### Users
78-
79-
* [GET /1/users/me](base_api_v1_users_me.md) - ユーザー情報を取得
80-
81-
### Items
82-
83-
* [GET /1/items](base_api_v1_items.md) - 商品情報の一覧を取得
84-
* [GET /1/items/search](base_api_v1_items_search.md) - ショップ内の商品の検索結果を取得
85-
* [GET /1/items/detail/:item_id](base_api_v1_items_detail.md) - 商品情報を取得
86-
* [POST /1/items/add](base_api_v1_items_add.md) - 商品情報を登録
87-
* [POST /1/items/edit](base_api_v1_items_edit.md) - 商品情報を更新
88-
* [POST /1/items/delete](base_api_v1_items_delete.md) - 商品情報を削除
89-
* [POST /1/items/add_image](base_api_v1_items_add_image.md) - 商品情報の画像を登録
90-
* [POST /1/items/delete_image](base_api_v1_items_delete_image.md) - 商品情報の画像を削除
91-
* [POST /1/items/edit_stock](base_api_v1_items_edit_stock.md) - 商品情報の在庫数を更新
92-
* [POST /1/items/delete_variation](base_api_v1_items_delete_variation.md) - 商品情報のバリエーションを削除
93-
94-
### Categories
95-
96-
* [GET /1/categories](base_api_v1_categories.md) - カテゴリー情報の一覧を取得
97-
* [POST /1/categories/add](base_api_v1_categories_add.md) - カテゴリー情報を登録
98-
* [POST /1/categories/edit](base_api_v1_categories_edit.md) - カテゴリー情報を更新
99-
* [POST /1/categories/delete](base_api_v1_categories_delete.md) - カテゴリー情報を削除
100-
101-
### ItemCategories
102-
103-
* [GET /1/item_categories/detail/:item_id](base_api_v1_item_categories_detail.md) - 商品のカテゴリー情報を取得
104-
* [POST /1/item_categories/add](base_api_v1_item_categories_add.md) - 商品のカテゴリー情報を登録
105-
* [POST /1/item_categories/delete](base_api_v1_item_categories_delete.md) - 商品のカテゴリー情報を削除
106-
107-
### Orders
108-
109-
* [GET /1/orders](base_api_v1_orders.md) - 注文情報の一覧を取得
110-
* [GET /1/orders/detail/:unique_key](base_api_v1_orders_detail.md) - 注文情報を取得
111-
* [POST /1/orders/edit_status](base_api_v1_orders_edit_status.md) - 注文情報のステータスを更新
112-
113-
### Savings
114-
115-
* [GET /1/savings](base_api_v1_savings.md) - 振込申請情報の一覧を取得
116-
117-
### DeliveryCompanies
118-
119-
* [GET /1/delivery_companies](base_api_v1_delivery_companies.md) - 配送業者情報の一覧を取得
120-
121-
### Search
122-
123-
* [GET /1/search](base_api_v1_search.md) - BASE全体の商品の検索結果を取得
124-
* [GET /1/search/refresh](base_api_v1_search_refresh.md) - 検索で取得した商品情報を再取得
125-
126-
## APIの利用制限
127-
128-
現在はユーザーの1時間の利用上限を5000回、1日の利用上限を100000回に設定しています。
129-
130-
上限を超えるとエラーレスポンスを返します。00分になると利用回数がリセットされます。
131-
132-
```
133-
{
134-
"error":"hour_api_limit",
135-
"error_description":"1時間のAPIの利用上限を超えました。時間が変わってからもう一度アクセスしてください。"
136-
}
137-
```
138-
```
139-
{
140-
"error":"day_api_limit",
141-
"error_description":"1日のAPIの利用上限を超えました。日付が変わってからもう一度アクセスしてください。"
142-
}
143-
```
144-
145-
## サンプルプログラム
146-
147-
* [PHP](samples/sample.php)
148-
149-
## 注意点
150-
151-
BASE APIは現在β版のため仕様が変更される場合があります。
152-
153-
## API利用規約
154-
[http://thebase.in/pages/api_term](http://thebase.in/pages/api_term)
155-
156-
## お問い合わせ
157-
158-
developers[at]thebase.in
159-
160-
BASE Developers [https://developers.thebase.in](https://developers.thebase.in)
3+
https://docs.thebase.in/docs/api/

‎base_api_v1_categories.md

+2-81
Original file line numberDiff line numberDiff line change
@@ -1,82 +1,3 @@
1-
# GET /1/categories
1+
このドキュメントは下記のページへ移動しました。
22

3-
カテゴリー情報の一覧を取得
4-
5-
## scope
6-
7-
read_items
8-
9-
## リクエストパラメーター
10-
11-
なし
12-
13-
## レスポンスの例
14-
15-
```
16-
{
17-
"categories":[
18-
{
19-
"category_id":1234,
20-
"name":"メンズ",
21-
"list_order":1,
22-
"number":1,
23-
"parent_number":0,
24-
"code":"0001"
25-
},
26-
{
27-
"category_id":1235,
28-
"name":"トップス",
29-
"list_order":1,
30-
"number":2,
31-
"parent_number":1,
32-
"code":"0001-0002"
33-
},
34-
{
35-
"category_id":1236,
36-
"name":"Tシャツ",
37-
"list_order":1,
38-
"number":3,
39-
"parent_number":2,
40-
"code":"0001-0002-0003"
41-
},
42-
{
43-
"category_id":1237,
44-
"name":"レディーズ",
45-
"list_order":2,
46-
"number":4,
47-
"parent_number":0,
48-
"code":"0004"
49-
}
50-
]
51-
}
52-
```
53-
54-
## 解説
55-
56-
* category_id - カテゴリーを識別するユニークなID
57-
* name - カテゴリー名
58-
* list_order - カテゴリーの並び順
59-
* number - カテゴリー番号
60-
* parent_number - 親カテゴリー番号
61-
* code - カテゴリーコード。カテゴリー番号をハイフンで繋げたもの。最大3階層まで。
62-
63-
## エラーレスポンスの例
64-
65-
```
66-
{
67-
"error":"access_denied",
68-
"error_description":"httpsでアクセスしてください。"
69-
}
70-
```
71-
```
72-
{
73-
"error":"invalid_request",
74-
"error_description":"アクセストークンが無効です。"
75-
}
76-
```
77-
```
78-
{
79-
"error":"invalid_scope",
80-
"error_description":"スコープが無効です。"
81-
}
82-
```
3+
https://docs.thebase.in/docs/api/categories/

‎base_api_v1_categories_add.md

+2-103
Original file line numberDiff line numberDiff line change
@@ -1,104 +1,3 @@
1-
# POST /1/categories/add
1+
このドキュメントは下記のページへ移動しました。
22

3-
カテゴリー情報を登録
4-
5-
## scope
6-
7-
write_items
8-
9-
## リクエストパラメーター
10-
11-
| Name | Description |
12-
|---------------|---------------------------|
13-
| name | カテゴリー名 (必須) |
14-
| list_order | カテゴリーの並び順 (任意) |
15-
| parent_number | 親カテゴリー番号 (任意) |
16-
17-
## レスポンスの例
18-
19-
```
20-
{
21-
"categories":[
22-
{
23-
"category_id":1234,
24-
"name":"メンズ",
25-
"list_order":1,
26-
"number":1,
27-
"parent_number":0,
28-
"code":"0001"
29-
},
30-
{
31-
"category_id":1235,
32-
"name":"トップス",
33-
"list_order":1,
34-
"number":2,
35-
"parent_number":1,
36-
"code":"0001-0002"
37-
},
38-
{
39-
"category_id":1236,
40-
"name":"Tシャツ",
41-
"list_order":1,
42-
"number":3,
43-
"parent_number":2,
44-
"code":"0001-0002-0003"
45-
},
46-
{
47-
"category_id":1237,
48-
"name":"レディーズ",
49-
"list_order":2,
50-
"number":4,
51-
"parent_number":0,
52-
"code":"0004"
53-
}
54-
]
55-
}
56-
```
57-
58-
## 解説
59-
60-
* category_id - カテゴリーを識別するユニークなID
61-
* name - カテゴリー名
62-
* list_order - カテゴリーの並び順
63-
* number - カテゴリー番号
64-
* parent_number - 親カテゴリー番号
65-
* code - カテゴリーコード。カテゴリー番号をハイフンで繋げたもの。最大3階層まで。
66-
67-
## エラーレスポンスの例
68-
69-
```
70-
{
71-
"error":"access_denied",
72-
"error_description":"httpsでアクセスしてください。"
73-
}
74-
```
75-
```
76-
{
77-
"error":"invalid_request",
78-
"error_description":"アクセストークンが無効です。"
79-
}
80-
```
81-
```
82-
{
83-
"error":"invalid_scope",
84-
"error_description":"スコープが無効です。"
85-
}
86-
```
87-
```
88-
{
89-
"error":"not_post_method",
90-
"error_description":"POSTで送信してください。"
91-
}
92-
```
93-
```
94-
{
95-
"error":"bad_parent_number",
96-
"error_description":"不正なparent_numberです。"
97-
}
98-
```
99-
```
100-
{
101-
"error":"validation_error",
102-
"error_description":"バリデーションエラーです。"
103-
}
104-
```
3+
https://docs.thebase.in/docs/api/categories/add

0 commit comments

Comments
 (0)