Passer au contenu principal
GET
/
v1
API Avatars
curl --request GET \
  --url https://avatars.cleariflow.com/v1
L’utilisation de ce service est simple : il vous suffit de fournir votre api_key ainsi qu’un name, et le système créera une image d’avatar correspondant aux initiales du nom fourni.

​
Premiers pas

​
REST

L’API Avatars suit le même modèle architectural que tous les services Cleariflow, construite autour des principes REST. Elle utilise des URL prévisibles, orientées ressources, et des codes de statut HTTP pour communiquer les erreurs.

​
HTTPS

L’API Avatars exige que toutes les transmissions de données soient protégées par des protocoles de chiffrement TLS 1.2 ou supérieur.

​
Versions de l’API

Chaque service Cleariflow inclut le versionnage. L’API Avatars fonctionne actuellement en version 1.

​
Votre clé API

Votre clé API sert d’identifiant d’authentification exclusif pour accéder à l’API Avatars Cleariflow. Gardez à l’esprit que chaque service Cleariflow possède sa propre clé API distincte ; vous aurez donc besoin de clés séparées pour différents services comme l’API Avatars et l’API de validation d’e-mail. Pour vérifier vos requêtes, vous devez inclure votre clé API dans l’URL de base.

​
URL de base

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

​
Endpoint de validation

L’API Avatars Cleariflow ne nécessite que votre clé API exclusive et le nom de l’utilisateur pour la génération d’avatar : 
https://avatars.cleariflow.com/v1/
? api_key = YOUR_UNIQUE_API_KEY
& name = Alexander Rodriguez
Cette requête a été traitée avec succès, et l’avatar résultant pour le nom spécifié apparaît ci-dessous : Avatar pour Alexander Rodriguez

​
Paramètres de requête

​
api_key
String
requis
Votre clé API exclusive. N’oubliez pas que chaque utilisateur possède des clés API uniques pour chaque service Cleariflow ; votre clé de l’API Avatars ne fonctionnera pas avec votre API de géolocalisation IP, par exemple.
​
name
String
requis
Le nom pour lequel vous souhaitez générer un avatar. Vous pouvez saisir plusieurs noms (y compris prénom, deuxième prénom et nom de famille), et le service affichera automatiquement deux lettres dans l’avatar. Vous pouvez modifier le nombre de lettres à l’aide du paramètre char_limit ci-dessous.
​
image_size
Integer
Les dimensions de l’image d’avatar carrée en pixels. La valeur par défaut est 64 pixels, avec des tailles disponibles de 6 à 512 pixels.
​
image_format
String
Le format préféré pour l’image générée. La valeur par défaut est « png », mais vous pouvez également choisir « svg ».
​
font_size
Float
La taille de police exprimée en pourcentage de image_size. La valeur par défaut est 0,7, avec des valeurs acceptables entre 0,1 et 1,0.
​
char_limit
Integer
Le nombre maximum de caractères à afficher dans l’avatar. La valeur par défaut est 2. Le nombre réel de caractères affichés peut être inférieur à cette limite, mais jamais supérieur. La sélection des caractères privilégie d’abord les mots distincts, puis la deuxième lettre des mots distincts.
​
background_color
String
Le code couleur hexadécimal pour l’arrière-plan. La valeur par défaut est #335eea. Lorsque vous spécifiez une couleur hex, omettez le symbole « # ». Par exemple, &background_color=e4704a est valide tandis que &background_color=#e4704a est invalide.
​
font_color
String
Le code couleur hexadécimal pour le texte. La valeur par défaut est blanc (ffffff). Lorsque vous spécifiez une couleur hex, omettez le symbole « # ». Par exemple, &font_color=e4704a est valide tandis que &font_color=#e4704a est invalide.
​
is_rounded
Boolean
Génère une image d’avatar circulaire au lieu d’une image carrée. La valeur par défaut est false.
​
is_uppercase
Boolean
Convertit toutes les initiales de l’avatar en majuscules. La valeur par défaut est true.
​
is_italic
Boolean
Applique un style italique à toutes les initiales de l’avatar. La valeur par défaut est false.
​
is_bold
Boolean
Applique un style gras à toutes les initiales de l’avatar. La valeur par défaut est false.