API/Webhook一覧


ゲーオクConnectが提供するAPIとWebhookの一覧です。
開発を申し込んでいただいた場合にご利用いただけます。

API/Webhook名 用途
ユーザ登録確認API ユーザのアカウント(メールアドレス)がゲーオクConnectに登録されているかどうかを確認します。
ユーザをゲーオクConnectにログインさせる際、アカウント新規登録かログインかを判断する場合に使用します。
ユーザ新規登録API ユーザのアカウントを新規で作成します。
メールを使った2段階認証の有無を選択できます。
ユーザ情報をゲーオクConnectに登録する場合に使用します。
ログインAPI ユーザのメールアドレスとパスワードを認証し、ゲーオクConnectにログインします。
ログインに成功した場合はユーザトークンを返します。
ユーザをゲーオクConnectにログインさせる場合に使用します。
ユーザ情報取得API ゲーオクConnectに登録されたユーザの情報をユーザ単位で取得します。
プロフィール編集画面で現在の登録内容を表示する場合等に使用します。
メールアドレス変更API ユーザのメールアドレスを変更します。
2段階認証となっており、新しいメールアドレスに送られてくるメールに書かれたURLを開いた場合に変更が反映されます。
プロフィール編集画面等で使用します。
パスワード変更API ユーザのパスワードを変更します。
プロフィール編集画面等で使用します。
ユーザ情報変更API メールアドレス、パスワード以外のユーザの登録を変更します。
現状、変更できる情報はニックネームのみです。
プロフィール編集画面等で使用します。
パスワード再設定API パスワード再設定画面のURLをユーザのメールアドレスに送付し、パスワードを更新します。
ユーザがパスワードを忘れてログインできない場合に使用します。
出品一覧取得API 出品された商品の概要の一覧をゲーム単位で取得します。
オークションホーム画面や出品一覧画面等で使用します。
商品詳細取得API 商品の出品情報や入札状況、コメントやステータス等を商品単位で取得します。
商品コメントAPI 出品中の商品に対し質問等のコメントを投稿します。
コメントがあった場合、出品者に通知されます。
商品詳細画面等で使用します。
出品管理API ユーザが出品した商品の概要の一覧をゲーム単位で取得します。
出品API 商品を出品します。
出品した商品は、出品ユーザの所持数から減らす必要があります。
出品取消API 自身が出品した商品の出品を取り消します。
入札がある商品に対しては実行できません。
このAPIを実行した場合は、対象商品を出品ユーザの所持へ戻す必要があります。
出品管理画面等の機能として使用します。
取引終了通知Webhook 商品の出品または取引が終了したことをゲーム側に通知します。
出品ユーザがゲーオクConnect内で出品終了操作を行った場合、出品期限内に落札が成立しなかった場合、または落札後期限内に支払いが行われなかった場合に発生します。
このWebhookが発行された場合は、対象商品を出品ユーザの所持へ戻す必要があります。
入札管理API ユーザが入札または落札した商品の概要の一覧をゲーム単位で取得します。
入札API 出品中の商品に対し入札または落札を行います。
入札があった場合、出品者に通知されます。
入札額を高値更新した場合は、高値更新されたユーザにも通知されます。
ウォッチリスト取得API ユーザがウォッチリストに登録した商品の概要の一覧をゲーム単位で取得します。
ウォッチリスト登録削除API 商品をウォッチリストへ登録、またはウォッチリストから削除します。
登録は商品詳細画面等から行い、削除は商品詳細画面またはウォッチリスト一覧画面から行います。
仮支払い完了通知Webhook 商品落札後、落札ユーザがゲーオクConnect側で支払いを行ったことをゲーム側に通知します。
取引確定API 落札した商品の取引を完了させます。
仮支払い完了通知Webhookを受け、ゲーム側で商品の移動が完了した際に使用します。
商品の移動が完了したことが出品ユーザと落札ユーザに通知されます。
評価取得API ユーザが他のユーザから付けられた評価を取得します。

評価は、出品者としての評価と落札者としての評価の2種類あります。 評価画面等で使用します。
評価API 他のユーザに対して評価を付けます。
同じユーザに対して2回以上評価した場合は上書き更新されます。
評価を付けられたユーザに通知されます。
評価画面等で使用します。


API/Webhookの実装サンプル

各API/Webhookのゲームの中への組み込み例を図示します。
ただし、下図はあくまで例であり、この通りに設計する必要はありません。
また、すべてのAPIおよびAPIの戻り値を使用しないといけないわけではありませんので、ゲーム設計により検討してください。


▼ユーザ管理関連

▼オークション関連

▼マイオークション関連