メインコンテンツへスキップ
GET
/
v1
アバターAPI
curl --request GET \
  --url https://avatars.cleariflow.com/v1
このサービスの利用は簡単です。api_key と name を指定するだけで、提供された名前のイニシャルに対応するアバター画像が生成されます。

​
はじめに

​
REST

アバターAPIはCleariflowのすべてのサービスと同じアーキテクチャパターンに従い、RESTの原則を中心に構築されています。予測可能なリソース指向のURLを採用し、エラー通知にHTTPステータスコードを使用します。

​
HTTPS

アバターAPIでは、すべてのデータ送信をTLS 1.2以上の暗号化プロトコルで保護する必要があります。

​
APIバージョン

Cleariflowのすべてのサービスにはバージョン管理が含まれます。アバターAPIは現在バージョン1で稼働しています。

​
APIキー

APIキーは、CleariflowアバターAPIにアクセスするための唯一の認証情報です。Cleariflowの各サービスには固有のAPIキーがあるため、アバターAPIとメール検証APIなどでは異なるキーが必要です。リクエストを認証するには、ベースURLにAPIキーを含める必要があります。

​
ベースURL

https://avatars.cleariflow.com/v1/

​
検証エンドポイント

CleariflowアバターAPIでは、アバター生成に固有のAPIキーとユーザーの名前のみが必要です。 
https://avatars.cleariflow.com/v1/
? api_key = YOUR_UNIQUE_API_KEY
& name = Alexander Rodriguez
このリクエストは正常に処理され、指定された名前のアバターが以下に表示されます。 Alexander Rodriguezのアバター

​
リクエストパラメータ

​
api_key
String
必須
固有のAPIキーです。各ユーザーはCleariflowの各サービスごとに固有のAPIキーを持っているため、アバターAPIのキーはIPジオロケーションAPIなどでは動作しません。
​
name
String
必須
アバターを生成したい名前です。複数の名前（名、ミドルネーム、姓を含む）を入力でき、サービスはアバターに2文字を自動的に表示します。以下の char_limit パラメータで文字数を変更できます。
​
image_size
Integer
正方形アバター画像のピクセルサイズです。デフォルトは64ピクセルで、6〜512ピクセルの範囲で指定できます。
​
image_format
String
生成画像の希望フォーマットです。デフォルトは「png」ですが、「svg」も選択できます。
​
font_size
Float
image_sizeに対する割合で表したフォントサイズです。デフォルトは0.7で、0.1〜1.0の範囲が有効です。
​
char_limit
Integer
アバターに表示する最大文字数です。デフォルトは2です。実際に表示される文字数はこの上限より少ない場合がありますが、それ以上になることはありません。文字の選択は、まず異なる単語、次に異なる単語の2文字目を優先します。
​
background_color
String
背景の16進数カラーコードです。デフォルトは #335eea です。16進数カラーを指定する際は「#」記号を省略してください。例：&background_color=e4704a は有効、&background_color=#e4704a は無効です。
​
font_color
String
テキストの16進数カラーコードです。デフォルトは白（ffffff）です。16進数カラーを指定する際は「#」記号を省略してください。例：&font_color=e4704a は有効、&font_color=#e4704a は無効です。
​
is_rounded
Boolean
正方形ではなく円形のアバター画像を生成します。デフォルトは false です。
​
is_uppercase
Boolean
アバター内のすべてのイニシャルを大文字に変換します。デフォルトは true です。
​
is_italic
Boolean
アバター内のすべてのイニシャルにイタリック体を適用します。デフォルトは false です。
​
is_bold
Boolean
アバター内のすべてのイニシャルに太字を適用します。デフォルトは false です。