> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cleariflow.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Avatars

> L'API Avatars di Cleariflow è un'API RESTful JSON veloce, leggera e moderna per creare immagini avatar altamente personalizzabili con il nome o le iniziali di una persona, per migliorare l'esperienza utente.

L'utilizzo di questo servizio è semplice: fornisci il tuo `api_key` insieme a un `name`, e il sistema creerà un'immagine avatar corrispondente alle iniziali del nome fornito.

## Per iniziare

### REST

L'API Avatars segue lo stesso schema architetturale di tutti i servizi Cleariflow, costruita attorno ai principi REST. Utilizza URL prevedibili e orientati alle risorse e i codici di stato HTTP per comunicare gli errori.

### HTTPS

L'API Avatars richiede che tutta la trasmissione dei dati sia protetta con protocolli di crittografia TLS 1.2 o superiore.

### Versioni API

Ogni servizio Cleariflow include il versionamento. L'API Avatars opera attualmente sulla versione 1.

### La tua chiave API

La tua chiave API funge da credenziale di autenticazione esclusiva per accedere all'API Avatars di Cleariflow. Tieni presente che ogni servizio Cleariflow possiede una chiave API distinta, quindi avrai bisogno di chiavi separate per servizi diversi come Avatars e validazione email. Per verificare le richieste, devi includere la chiave API nell'URL di base.

### URL di base

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

### Endpoint di validazione

L'API Avatars di Cleariflow richiede solo la tua chiave API esclusiva e il nome dell'utente per generare l'avatar:

```
https://avatars.cleariflow.com/v1/
? api_key = YOUR_UNIQUE_API_KEY
& name = Alexander Rodriguez
```

Questa richiesta è stata elaborata con successo e l'avatar risultante per il nome specificato appare di seguito:

<img alt="Avatar for Alexander Rodriguez" src="https://mintcdn.com/cleariflow/JFqWO7lxhDZeTQpu/assets/cf_avatar.png?fit=max&auto=format&n=JFqWO7lxhDZeTQpu&q=85&s=45fdc40cc251d6313c13a9c620b320b7" width="64" height="64" data-path="assets/cf_avatar.png" />

### Parametri della richiesta

<ParamField query="api_key" type="String" required>
  La tua chiave API esclusiva. Ricorda che ogni utente possiede chiavi API univoche per ogni servizio Cleariflow, quindi la chiave dell'API Avatars non funzionerà con l'API di geolocalizzazione IP, ad esempio.
</ParamField>

<ParamField query="name" type="String" required>
  Il nome per cui desideri generare un avatar. Puoi inserire più nomi (inclusi nome, secondo nome e cognome) e il servizio mostrerà automaticamente due lettere nell'avatar. Puoi modificare il numero di lettere usando il parametro char\_limit di seguito.
</ParamField>

<ParamField query="image_size" type="Integer">
  Le dimensioni dell'immagine avatar quadrata in pixel. Il valore predefinito è 64 pixel, con dimensioni disponibili da 6 a 512 pixel.
</ParamField>

<ParamField query="image_format" type="String">
  Il formato preferito per l'immagine generata. Il valore predefinito è "png", ma puoi anche scegliere "svg".
</ParamField>

<ParamField query="font_size" type="Float">
  La dimensione del carattere espressa come percentuale di image\_size. Il valore predefinito è 0.7, con valori accettabili tra 0.1 e 1.0.
</ParamField>

<ParamField query="char_limit" type="Integer">
  Il numero massimo di caratteri da visualizzare nell'avatar. Il valore predefinito è 2. Il numero effettivo di caratteri mostrati può essere inferiore a questo limite, ma mai superiore. La selezione dei caratteri privilegia prima le parole distinte, poi la seconda lettera delle parole distinte.
</ParamField>

<ParamField query="background_color" type="String">
  Il codice colore esadecimale per lo sfondo. Il valore predefinito è #335eea. Quando specifichi un colore hex, ometti il simbolo "#". Ad esempio, \&background\_color=e4704a è valido mentre \&background\_color=#e4704a non lo è.
</ParamField>

<ParamField query="font_color" type="String">
  Il codice colore esadecimale per il testo. Il valore predefinito è bianco (ffffff). Quando specifichi un colore hex, ometti il simbolo "#". Ad esempio, \&font\_color=e4704a è valido mentre \&font\_color=#e4704a non lo è.
</ParamField>

<ParamField query="is_rounded" type="Boolean">
  Genera un'immagine avatar circolare invece di quadrata. Il valore predefinito è false.
</ParamField>

<ParamField query="is_uppercase" type="Boolean">
  Converte tutte le iniziali nell'avatar in lettere maiuscole. Il valore predefinito è true.
</ParamField>

<ParamField query="is_italic" type="Boolean">
  Applica lo stile corsivo a tutte le iniziali nell'avatar. Il valore predefinito è false.
</ParamField>

<ParamField query="is_bold" type="Boolean">
  Applica lo stile grassetto a tutte le iniziali nell'avatar. Il valore predefinito è false.
</ParamField>
