Applicationについて

[tiwanari]

Applicationについて、準備や本番の環境の改善できそうなところ・困っているところなどなんでもコメント

[tiwanari]

みんなGo初心者みたいなところあるので、Go自体の勉強と、Goでつくるwebappについて学んでおくとよいかな

[vintersnow]

ISUCARI アプリケーション仕様書

ISUCARIは椅子を売りたい人／買いたい人をつなげるフリマアプリです。 従来のECサービスと比べて以下の特徴があります。

• 安心安全の決済基盤
• 匿名配送により住所を伝えなくても取引が可能に
• 買いたい／売りたいと思った時にすぐに使えるシンプルさ

ISUCARIの使い方

椅子を売ろう！

まずは椅子を出品しよう！

1. 椅子の情報をいれよう！
   • タイムラインページの右下の出品ボタンを押すと出品画面にいくよ！
   • シンプルなフォームに情報を入力すれば即出品♪
   • 
2. 売れるのを待とう！
   • あなたの椅子が買われるのを楽しみに待とう♪
3. 椅子を発送しよう！
   • 無事購入されたら椅子を発送しよう！
   • 商品ページかマイページから取引画面に行こう👀

売れた椅子を発送しよう！

1. 集荷予約をしよう！
   • 集荷予約をして椅子を送る準備をしよう😤
   • 集荷予約は取引画面からできるぞ！
   • 
2. 配達員に椅子をわたそう！
   • 配達員が来たらQRコードを見せよう📱
   • 椅子を渡したら発送完了ボタンを押そう♪
   • 
3. 購入者の受け取りを待とう！
   • 椅子が届くのをまとう♪
   • 届いたかどうかは取引画面で確認できるぞ！
   • 購入者が椅子を受け取ったら取引完了♪

椅子を買おう！

1. ほしい椅子を探そう！
   • タイムライン、カテゴリタイムラインから好みの椅子を探そう👀
   • カテゴリタイムラインへはサイドバーからいけるよ！
   • 
2. 椅子を買おう！
   • 運命の椅子を見つけたら購入しよう😎
   • カード番号を入力して簡単1ステップ購入！
   • 
3. 椅子が届くのを待とう⏱
   • 出品者が発送するのを待とう！
   • 発送されたかどうかは取引画面で確認できるぞ！
4. 取引を完了しよう！
   • 椅子が届いたら「取引完了」をしよう！
   • これで取引完了♪

キャンペーン機能について

マニュアルを参照

外部サービスの仕様

外部サービス仕様書 を参照

ISUCARI ステータス遷移表

	WHO	items	transaction_evidences	shippings
/sell （出品）	出品者	on_sale	-	-
/buy （購入）	購入者	trading	wait_shipping	initial
/ship （集荷予約）	出品者	↓	↓	wait_pickup
/ship_done （発送完了）	出品者	↓	wait_done	shipping or done
/complete （取引完了）	購入者	sold_out	done	done

[vintersnow]

外部サービスAPIの仕様

予選マニュアルに利用可能なURLなどの情報があるので確認してください。

payment service

決済サービスAPI。クレジットカード情報の非保持化にも対応しているので安心して利用できます。

POST /card

• 加盟店ID(shop_id)とカード番号(card_number)を送ると、その加盟店IDで5分間だけ使えるトークンを発行できる
• 外部サービスからJavaScript経由でアクセスするのでCross-Origin Resource Sharing (CORS)に対応
• カード番号の形式は[0-9A-F]{8}

API仕様

• request: application/json
  • shop_id
  • card_number
• response: application/json
  • http status code: 200
  • token
  • http status code: 400
  • error: json decode error
  • error: wrong shop id
  • error: card number is wrong

example:

# request
{
  "shop_id": "11",
  "card_number": "AAAAAAAA"
}

# response
{
  "token": "abcdefg"
}

{
  "error": "card number is wrong"
}

POST /token

• 加盟店IDに紐付くAPIキー・加盟店IDに紐付くトークン・値段を送ると実際に決済が行われる
• 残高不足などの理由で正当なカード番号でも決済に失敗するケースがある

API仕様

• request: application/json
  • shop_id
  • token
  • api_key
  • price
• response: application/json
  • http status code: 200
  • status: ok
    • 決済成功
  • status: fail
    • 決済失敗
  • status: invalid
    • 無効なトークン
  • http status code: 400
  • error: json decode error
  • error: wrong shop id
  • error: wrong api key

example:

# request
{
  "shop_id": "11",
  "token": "abcd",
  "api_key": "itisapikey",
  "price": 10000
}

# response
{
  "status": "ok"
}

{
  "error": "wrong shop id"
}

shipment service

配送サービスAPI。配送会社が直接住所を扱うことで、お客様同士は住所を教え合うことなく利用できます。

Authorization

AuthorizationヘッダのBearerトークンに、予め払い出されているユニークなappidを使用して認証を行う。

Authorization: Bearer <APP_ID>

POST /create

• 集荷予約の作成
• 配送先の住所・配送元の住所・名前を送ると数字10桁のid（集荷予約ID）が送られてくる

API仕様

• request: application/json
  • to_address
  • to_name
  • from_address
  • from_name
• response: application/json
  • http status code: 200
  • reserve_id: 0000000000
  • reserve_time: 1570000000
    • (epoch time)
  • http status code: 400
  • error: json decode error
  • error: required parameter was not passed
  • http status code: 401
  • （Authorization失敗）

POST /request

• 集荷リクエスト
• 集荷予約IDを送ると集荷リクエストができる
• レスポンスは /accept へのURLが書かれているQRコードの画像ファイル
• サービス側は画像を保存して、自前で配信する必要がある

API仕様

• request: application/json
  • reserve_id
• response: image/png (error時はapplication/json)
  • http status code: 200
  • png binary
  • http status code: 400
  • error: json decode error
  • error: required parameter was not passed
  • error: empty
  • http status code: 401
  • （Authorization失敗）

GET /accept

• 発送
• 集荷予約IDとトークンを一緒にリクエストをする必要がある
  • QRコードのURLに正しいトークンが付与されている
• 配達員が開く想定なので、配達員しか知らない認証を入れるべきだが、ISUCON的に厳しそうなので現在は認証なし

API仕様

• request: application/json
  • reserve_id
• response: application/json
  • http status code: 200
  • accept: ok
  • http status code: 400
  • error: wrong parameters
  • error: empty

GET /status

• 配送ステータス
• 集荷予約IDを送ると initial, wait_pickup, shipping, done のどれかのステータスが返ってくる

API仕様

• request: application/json
  • reserve_id
• response: application/json
  • http status code: 200
  • reserve_time: 1570000000
    • (epoch time)
  • status: done
    • 下記参照
  • http status code: 400
  • error: json decode error
  • error: required parameter was not passed
  • error: empty
  • http status code: 401
  • （Authorization失敗）

ステータスの仕様

ステータスは以下

1. initial: 集荷予約作成
   • /create を呼ばれた後はこの状態
2. wait_pickup: 集荷待ち
   • /request を呼ばれた後はこの状態
3. shipping: 配送中
   • /accept を呼ばれた後はこの状態
4. done: 配送完了
   • 配送が終了するとこのステータスになる

[vintersnow]