Skip to content

クイックスタート

このページでは、ゲスト用アバターの作成からそのアバターの画像URL取得までを、コンソール経由でAPIを実行しながら説明します。

お試し用途のAPIキーの入手

Avatar Play デベロッパートップからお問い合わせください。現在クローズドβ版での提供につき、事前に用途をお聞きした上で提供させていただいております。

デモ

ゲスト用アバターの作成

自社アプリのユーザにアバターを付与するために、Guest API をPOSTメソッドで呼び出してゲスト用アバターのアバターIDを発行します。

$ curl -X POST "https://api.avatarplay3d.com/avatar/v1/Guest?key={APIキー}" -d ""
{
 "avatarId": "5723545988497408",
 "accessToken": "ca6c71c64f4bc20b03fa547567e4941e67ad748d39ce89f50f083b24be4821df",
 "scope": "AvatarLoad",
 "tokenType": "Bearer"
}

5723545988497408 が新しく発行されたアバターIDです。同時にアクセストークンも発行されますが、RESTful API のみを利用する場合は必要ないため破棄します。このアバターIDを自社アプリのユーザと紐付けておくことで、Avatar API を使ってそのユーザのアバター画像URLを取得できます。

Info

ゲスト用アバターが必要となるのは、着せ替えアプリとの連携前に何かしらのアバター画像を表示したいケースなどです。デフォルトのアバターが自社アプリ側で準備されている場合などでは必要ありません。

アバター画像URLの取得

アバターIDを指定して Avatar API をGETメソッドで呼び出してアバター画像URLを取得します。

$ curl "https://api.avatarplay3d.com/avatar/v1/Avatars?key={APIキー}&avatarId=5723545988497408"
{
 "avatars": [
  {
   "avatarId": "5723545988497408",
   "avatarImageUrl": "https://ava-a.mbga.jp/img_ava/701/52/0/391400001.401400001.423421632.461400011.513237271/avatar.gif?s=ae74c7953201420ad97759b109c3dfed660238d8e5facfddb51fe99ee1fad2b4",
   "avatarNonAnimationImageUrl": "https://ava-a.mbga.jp/img_ava/701/52/0/391400001.401400001.423421632.461400011/avatar.gif?s=10f8e18147aa76393eef201e4e145fc76b236fd5877ab8c9c8ea108ce197ac45",
   "faceImageUrl": "https://ava-a.mbga.jp/img_ava/701/1/0/391400001.401400001.423421632.461400011/avatar.gif?s=57f60a95e2f6b6f5a13ff4eb20f2a3341d3675ef79de31bb15f528eb715b19fc",
   "status": 200,
   "guest": true
  }
 ]
}

ここで取得した画像URLを自社アプリに埋め込んで、アバター画像を表示します。

顔のみアバター

自社アプリに組み込む

アプリ登録

自社アプリに組み込む場合、事前にデベロッパー登録とアプリ登録を行う必要があります。次の情報を Avatar Play 担当者に伝えてください。

項目 説明
組織のドメイン 自社のドメインなど。管理上利用しているもののため、APIの動作には直接影響しない。 com.example
アプリのURL アプリのURL http://example.com/app

サーバ実装

自社アプリのサーバから、RESTful API を呼び出すよう実装してください。