Overview

Version information

Version : 1.0.0

URI scheme

Host : api.avatarplay3d.com
BasePath : /
Schemes : HTTPS

Consumes

  • application/json

Produces

  • application/json

Paths

GET /avatar/v1/AccessToken

Description

付与トークンを渡し、アクセストークンとアバターIDを取得します。アバターIDを自社アプリのユーザと紐づけて、他のAPIで利用してください。RESTful APIのみを利用している場合、ここでのアクセストークンは破棄して問題ありません。

Parameters

Type Name Description Schema

Query

codeVerifier
required

ConnectUrlのcodeChallengeの生成で利用したcodeVerifier Example: 4hmLHty5K6P…

string

Query

redirectUri
required

ConnectUrlで指定したリダイレクトURI Example: https://example.com/oauth_callback

string

Query

requestDate
required

ConnectUrlのcodeChallengeの生成で利用したリクエスト日時 Example: 1552356284

integer (int64)

Query

scope
required

ConnectUrlで指定したスコープ Example: AvatarLoad,ItemGrant

string

Query

token
required

redirectUri経由で受け取ったtokenパラメータの値をそのまま指定します。 Example: veneh5On7MW…

string

Responses

HTTP Code Description Schema

200

成功

default

エラー

Security

Type Name

apiKey

GET /avatar/v1/Avatar

Description

アバターIDを指定して、アバター画像のURLなどを取得するAPIです。

Parameters

Type Name Schema

Query

avatarId
required

integer (int64)

Responses

HTTP Code Description Schema

200

成功

default

エラー

Security

Type Name

apiKey

GET /avatar/v1/Avatars

Description

アバターIDを指定して、アバター画像のURLなどを取得するAPIです。全身のアバター画像と、サムネイル表示などに使えるバストアップ画像のURLを取得できます。

全身のアバター画像には、テイストに応じたアニメーションが付きます。バストアップ画像にはアニメーションは付きません。

アバター画像はユーザによって変更される可能性があるため、この返り値をキャッシュすることはできません。

Parameters

Type Name Description Schema

Query

avatarId
required

アバターID。最低1つ指定する必要があり、最大50個まで指定できます。

個別のアバター画像の取得は失敗する可能性があり、取得に失敗したアバターIDが含まれていた場合も、全体のレスポンスとしては正常(200)を返します。個々のアバターIDのステータスは、statusプロパティで確認できます。

< integer (int64) > array(multi)

Responses

HTTP Code Description Schema

200

成功。アバター画像のURLリストを返します。

default

エラー

Security

Type Name

apiKey

GET /avatar/v1/ConnectUrl

Description

ID連携(OAuth認証)用のURLを取得します。

このURLへ遷移すると、Avatar Play 着せ替えアプリのインストールを経て、最後には付与トークンが付加されたリダイレクトURIへユーザーを誘導します。

Parameters

Type Name Description Schema

Query

codeChallenge
required

認証で利用するチャレンジ値。アプリID、応答種類(「grant_token」で固定)、リダイレクトURI、スコープ、リクエスト日時(UnixTime秒)、APIキー、検証用コードをこの順序でコロン「:」区切りに連結した文字列を、SHA256でハッシュ化した文字列になります。 Example: f39cbe206…

string

Query

redirectUri
required

最後にユーザを誘導するURL。URLの最後に、「token」パラメータが付与され、値に付与トークンが引き渡されます。この付与トークンは、AccessToken APIにそのまま引き渡します。 Example: https://example.com/oauth_callback

string

Query

scope
required

スコープ。パーミッション名をカンマ区切りで連結した文字列。 Example: AvatarLoad,ItemGrant

string

Responses

HTTP Code Description Schema

200

成功

default

失敗

Security

Type Name

apiKey

GET /avatar/v1/Coords

Description

アプリ内コーデの画像URLを取得するAPIです。コーデ画像はアニメーションしません。

この返り値はキャッシュできます。返り値が変更されるのは、アプリ内コーデの設定変更やAPI仕様が変わったときのみです。

Parameters

Type Name Description Schema

Query

coordId
optional

コーデID。複数指定可能です。事前にアプリ内で利用できるコーデとして割り当てられている必要があります。指定したコーデIDが見つからない場合、エラーを返します。この点は Avatars APIと挙動が異なるため、注意してください。

コーデIDを指定しなかった場合、アプリが初期コーデとして利用可能な全てのコーデ画像のリストを返します。

< integer (int64) > array(multi)

Responses

HTTP Code Description Schema

200

成功。コーデ画像のURLリストを返します。

default

失敗

Security

Type Name

apiKey

POST /avatar/v1/Guest

Description

ゲストアバターを新規作成します。発行されたアバターIDを自社サービスのユーザと紐づけることで、以降は Avatars APIを使ってユーザのアバター画像URLなどを取得できるようになります。

1ヶ月以上利用のない(Avatarss APIから全く呼ばれないなど)ゲストアバターは、自動的に削除されます。削除されたアバターIDは無効となるため、他のAPIでパラメータで指定しても存在しないアバターIDが指定されたとして扱われます。

Parameters

Type Name Description Schema

Query

coordId
optional

ゲストアバターのコーデIDを指定します。指定しない場合、デフォルトアバターのコーデになります。

integer (int64)

Responses

HTTP Code Description Schema

200

成功。ゲストアバターの情報が返ります。

default

失敗

Security

Type Name

apiKey

GET /avatar/v1/OpenUrl

Description

Avatar Play の起動URLを取得します。 このURLへ遷移すると、アプリインストール済みの場合はアプリが起動し、アプリ未インストールならアプリのインストール画面が開きます。 このURLは、リダイレクトの途中では利用できません。必ずWebページ内に埋め込む形でリンクしてください。

Responses

HTTP Code Description Schema

200

成功

default

失敗

Security

Type Name

apiKey

Definitions

AccessToken

連携したアバターのアバターIDとアクセストークンを収録しています。

Name Description Schema

accessToken
optional

アクセストークン。RESTful APIのみを利用する場合は破棄して問題ありません。
Example : "d030073d5d1…​"

string

avatarId
optional

アバターID。自社アプリ内でアバターを一意に表すIDです。RESTful APIのパラメータとして利用できます。
Example : 1234567890

integer (int64)

scope
optional

スコープ。ConnectUrl APIで渡したスコープと同じです。
Example : "AvatarLoad,ItemGrant"

string

tokenType
optional

トークンの種類。「Bearer」で固定です。
Example : "Bearer"

string

Avatar

アバター画像URLなどのアバター情報

Name Description Schema

avatarId
optional

アバターID
Example : 1234567890

integer (int64)

avatarImageUrl
optional

アバター全身画像のURL。画像は240x320ピクセルサイズのアニメーションGIFです。テイストに応じたアニメーションが付きます。
Example : "https://example.com/avatar.gif"

string

avatarNonAnimationImageUrl
optional

アバター全身画像のURLですが、アニメーションは付きません。画像は240x320ピクセルサイズのGIFファイルです。
Example : "https://example.com/avatar.gif"

string

faceImageUrl
optional

アバターバストアップ画像のURL。画像は60x80ピクセルサイズのGIFファイルです。アバターが正面を向いたアニメーションなしの画像です。サムネイルとしての利用などに適しています。
Example : "https://example.com/face.gif"

string

guest
optional

ゲストユーザなら真
Example : true

boolean

status
optional

アバターのステータスを返します。 200: 正常に画像取得 401: 画像取得のパーミッションが取れませんでした。ユーザがパーミッションを削除したなどの可能性があります。パーミッションを再取得することで改善する可能性があります。 404: 存在しないアバターです。アバターIDが誤っているか、ユーザが削除された可能性があります。
Example : 200

integer (int32)

Avatars

Avatar のリストです。

Name Schema

avatars
optional

< Avatar > array

ConnectUrl

ID連携用のURL

Name Description Schema

url
optional

ID連携用のURL
Example : "https://sdk.avatarplay3d.com/fit/lp"

string

Coord

コーデ画像URLのリスト

Name Description Schema

coordId
optional

コーデID
Example : 1234567890

integer (int64)

coordImageUrl
optional

コーデ画像のURL
Example : "https://example.com/coord.gif"

string

Coords

Coord のリストです。

Name Schema

coordImages
optional

< Coord > array

Error

Name Description Schema

code
optional

Example : 400

integer (int32)

errors
optional

< ErrorDetail > array

message
optional

Example : "Invalid string value"

string

ErrorDetail

Name Description Schema

domain
optional

Example : "global"

string

message
optional

Example : "String 'abc' not a valid integer"

string

reason
optional

Example : "badRequest"

string

ErrorResponse

Name Schema

error
optional

OpenUrl

Avatar Play の着せ替えアプリを起動するURL

Name Description Schema

url
optional

Avatar Play の着せ替えアプリを起動するURL
Example : "https://avatarplay3d.page.link/"

string

Security

api_key

Type : apiKey
Name : key
In : QUERY