> ## 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 de avatares

> La API de avatares de Cleariflow es una API JSON RESTful rápida, ligera y moderna para crear imágenes de avatar altamente personalizables con el nombre o las iniciales de una persona para mejorar la experiencia del usuario.

El uso de este servicio es sencillo: simplemente proporcione su `api_key` junto con un `name`, y el sistema creará una imagen de avatar que corresponde a las iniciales del nombre proporcionado.

## Primeros pasos

### REST

La API de avatares sigue el mismo patrón arquitectónico que todos los servicios de Cleariflow, construida en torno a los principios REST. Emplea URL predecibles orientadas a recursos y utiliza códigos de estado HTTP para comunicar errores.

### HTTPS

La API de avatares exige que toda la transmisión de datos esté protegida mediante protocolos de cifrado TLS 1.2 o superior.

### Versiones de la API

Cada servicio de Cleariflow incluye versionado. La API de avatares opera actualmente en la versión 1.

### Su clave API

Su clave API sirve como credencial de autenticación exclusiva para acceder a la API de avatares de Cleariflow. Tenga en cuenta que cada servicio de Cleariflow posee su propia clave API distinta, lo que significa que necesitará claves separadas para distintos servicios como las APIs de avatares y validación de email. Para verificar sus solicitudes, debe incluir su clave API en la URL base.

### URL base

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

### Endpoint de validación

La API de avatares de Cleariflow solo necesita su clave API exclusiva y el nombre del usuario para generar el avatar:

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

Esta solicitud se procesó correctamente y el avatar resultante para el nombre especificado aparece a continuación:

<img alt="Avatar para 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" />

### Parámetros de solicitud

<ParamField query="api_key" type="String" required>
  Su clave API exclusiva. Recuerde que cada usuario posee claves API únicas para cada servicio de Cleariflow, por lo que su clave de la API de avatares no funcionará con su API de geolocalización IP, por ejemplo.
</ParamField>

<ParamField query="name" type="String" required>
  El nombre para el que desea generar un avatar. Puede introducir varios nombres (incluidos nombre, segundo nombre y apellido), y el servicio mostrará automáticamente dos letras en el avatar. Puede modificar el número de letras mediante el parámetro char\_limit que se indica a continuación.
</ParamField>

<ParamField query="image_size" type="Integer">
  Las dimensiones de la imagen de avatar cuadrada en píxeles. El valor predeterminado es 64 píxeles, con tamaños disponibles que van de 6 a 512 píxeles.
</ParamField>

<ParamField query="image_format" type="String">
  El formato preferido para la imagen generada. El valor predeterminado es "png", pero también puede elegir "svg".
</ParamField>

<ParamField query="font_size" type="Float">
  El tamaño de fuente expresado como porcentaje de image\_size. El valor predeterminado es 0,7, con valores aceptables entre 0,1 y 1,0.
</ParamField>

<ParamField query="char_limit" type="Integer">
  El número máximo de caracteres a mostrar en el avatar. El valor predeterminado es 2. El número real de caracteres mostrados puede ser menor que este límite, pero nunca mayor. La selección de caracteres prioriza primero las palabras distintas y luego la segunda letra de palabras distintas.
</ParamField>

<ParamField query="background_color" type="String">
  El código de color hexadecimal para el fondo. El valor predeterminado es #335eea. Al especificar un color hexadecimal, omita el símbolo "#". Por ejemplo, \&background\_color=e4704a es válido mientras que \&background\_color=#e4704a no lo es.
</ParamField>

<ParamField query="font_color" type="String">
  El código de color hexadecimal para el texto. El valor predeterminado es blanco (ffffff). Al especificar un color hexadecimal, omita el símbolo "#". Por ejemplo, \&font\_color=e4704a es válido mientras que \&font\_color=#e4704a no lo es.
</ParamField>

<ParamField query="is_rounded" type="Boolean">
  Genera una imagen de avatar circular en lugar de cuadrada. El valor predeterminado es false.
</ParamField>

<ParamField query="is_uppercase" type="Boolean">
  Convierte todas las iniciales del avatar a mayúsculas. El valor predeterminado es true.
</ParamField>

<ParamField query="is_italic" type="Boolean">
  Aplica estilo cursiva a todas las iniciales del avatar. El valor predeterminado es false.
</ParamField>

<ParamField query="is_bold" type="Boolean">
  Aplica estilo negrita a todas las iniciales del avatar. El valor predeterminado es false.
</ParamField>