Skip to content

RESTful API 概要

Avatar Play の RESTful API(以降、API)は、自社アプリのサーバから呼び出せる 機能を提供します。自社アプリが本格的な3Dグラフィックス技術を必要としないアプリケーション(例えば非3DのWebアプリケーション)である場合も、アバター画像URLを取得して、自社アプリの画面にアバターを表示できます。

APIの特徴

低い導入コスト

APIへのアクセスは簡単です。ほとんどのAPIは、APIキーを指定するだけでアクセス可能です。

$ curl "https://api.avatarplay3d.com/avatar/v1/Avatar?key=AIzaSyDesIS9cDxOXDKaji04MsjL4jdLIbaYUGM&avatarId=4785444373921792"
{
 "avatarId": "4785444373921792",
 "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": false
}

多彩な利用シーンに対応

プロフィール画面では全身の大きなアバター画像を表示し、コミュニティ一覧では小さな顔のみのアバター画像を表示する、など使い分けが可能です。アニメーション付きの画像を使うことも可能です。

全身アバター 静止アバター 顔のみアバター

Webアプリケーションとのシームレスな接続

着せ替えアプリはWebアプリケーションの一部のように動作します。以下の動画は、サンプルのWebアプリケーションから着せ替えアプリを呼び出し、着せ替え完了後はWebアプリケーションに戻るデモです。

開発の大まかな流れ

  1. お問い合わせフォームより、APIの利用を希望して、サンプルのAPIキーを入手する
  2. サンプルを使って動作を確認する
  3. Avatar Play 担当者と組み込みイメージと実現性を確認する
  4. ライセンス契約(共同研究開発合意書)を結び、アプリ登録を行う
  5. アプリを開発し、リリースする

最低限の開発項目

自社アプリ側では、最低限以下の開発が必要になります。