Skip to content

概要

VRoid Hubでは外部アプリケーションがVRoid Hubにあるアバターファイルを利用するためのAPIを公開しています。

APIの利用にはVRoid Hubでの開発者登録アプリケーション(ClientID, ClientSecret)の発行OAuth2.0による認可が必要です。

VRoid Hub APIを利用すると、VRoid Hubに登録されたキャラクターを自分のアプリケーションで利用できるようになります。

Detail of VRoid Hub API

VRoid Hub APIとVRoid SDKとの違い

VRoid HubではAPIをUnityで利用するためのVRoid SDKも公開しています。

VRoid SDKはUnityアプリケーション開発者向けに作成された、下記のような機能を備えたUnity Packageのことを指します。

  • VRoid Hub APIでのOAuth2.0認可
  • VRoid Hub APIを利用したキャラクター情報の取得・アバターファイル(.vrmファイル)の読み込み
  • アバターファイルの表示

VRoid SDKはSDKダウンロードページからダウンロードできます。

OAuth2.0によるVRoid Hubサーバーとサードパーティアプリケーションの連携

VRoid HubではOAuth2.0によるサードパーティアプリケーションとの連携をサポートしています。

OAuth2.0による連携フローは下図の通りです。

OAuth2.0 flow chart

アバターファイル(VRMファイル)の読み込み

アバターファイル(VRMファイル)の読み込みの際にはAWS S3のpresigned URLを発行しています。具体的なフローは下図の通りになります。また、VRoid HubサーバーへのAPIリクエストの際にはOAuth連携時に発行したトークンが必要になります。

VRM loading flow chart