簡単出品王子APIの認証について

はじめに

本ページは簡単出品王子APIの認証についての資料です

APIの認証フロー

以下に、認証フローの図について詳細を説明します

api-flow


「アプリケーションサーバー」は御社が提供するアプリのWebサーバーです

「必須項目有り?」の判断はGETパラメータに以下の値があるか判定します

  • client_id
  • client_secret
  • state
  • uid
  • gid
  • sid

「リダイレクト?」の判断はレスポンスボディ(JSON形式)のresultの値が”redirect”か判定します

番号 概要 備考
1 ユーザーがアプリを起動 出品王子から起動した場合は、設定した「Redirect URI」にuid及びstateがGETパラメータで渡されます。直接ユーザーがアプリケーションサーバーにアクセスした場合は、uid及びstateはありません
2-1 access_tokenの取得 必須項目を元にAPIサーバーにaccess_tokenの発行を依頼します
2-2 uid・stateの取得 client_id、client_secretを元に出品王子サーバーにuid、gid、sid、stateの発行を依頼します
3 access_tokenの返却 正しいuid及びstateの場合、access_tokenを発行し返却します
4-1 uid・stateの取得 stateの有効期限が切れている場合、stateを再発行します
4-2 データアクセス access_tokenが取得出来た場合、APIを用いてデータの取得・更新などを実行します
5 実行結果の返却 データアクセスの実行結果を返却します。またaccess_tokenの有効期限(※1)が切れていてrefresh_tokenの有効期限内(※2)の場合は、実行結果と共に新しいaccess_tokenとrefresh_tokenを返却します(※3)
6-1 uid・stateの取得 refresh_tokenの有効期限が切れている場合、stateを再発行します
6-2 アプリのビジネスロジック データアクセスの結果を元にアプリのビジネスロジックを実施します。再びデータアクセスが必要な場合、4-2を実施します
7-1 アプリにリダイレクト uid、gid、sid、stateを発行し、リダイレクトします
7-2 ログイン画面の表示 ユーザーへ出品王子のログイン画面を表示します
8 ログイン ユーザーが出品王子にログインします。ログインしなかった場合は、アプリにリダイレクトされません

※1:「access_token」の有効期限は30分です

※2:「refresh_token」の有効期限は3日です

  • このエントリーをはてなブックマークに追加
  • Share on Tumblr