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

> A API de avatares da Cleariflow é uma API RESTful JSON rápida, leve e moderna para criar imagens de avatar altamente personalizáveis com iniciais a partir de um nome — para uma melhor experiência do utilizador.

Utilizar este serviço é simples: forneça a sua `api_key` juntamente com um `name`, e o sistema criará uma imagem de avatar com as iniciais do nome fornecido.

## Primeiros passos

### REST

A API de avatares segue o mesmo padrão arquitetónico que todos os serviços Cleariflow, construída em torno dos princípios REST. Utiliza URLs previsíveis orientadas a recursos e códigos de estado HTTP para comunicar erros.

### HTTPS

A API de avatares exige que toda a transmissão de dados esteja protegida mediante protocolos de encriptação TLS 1.2 ou superior.

### Versiones de la API

Cada serviço Cleariflow inclui versionamento. A API de avatares opera atualmente na versão 1.

### Su clave API

A sua chave API serve como credencial de autenticação exclusiva para aceder à API de avatares da Cleariflow. Tenha em conta que cada serviço Cleariflow possui a sua própria chave API distinta, pelo que precisará de chaves separadas para diferentes serviços como Avatars e Email Validation. Para autenticar os seus pedidos, inclua a sua chave API no URL base.

### URL base

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

### Endpoint de validação

A API de avatares da Cleariflow só precisa da sua chave API exclusiva e do nome do utilizador para gerar o avatar:

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

Este pedido foi processado com sucesso e o avatar resultante para o nome especificado aparece abaixo:

<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 pedido

<ParamField query="api_key" type="String" required>
  A sua chave API exclusiva. Lembre-se de que cada utilizador possui chaves API únicas para cada serviço Cleariflow, por isso a sua chave da API de avatares não funcionará com a sua API de geolocalização IP, por exemplo.
</ParamField>

<ParamField query="name" type="String" required>
  O nome para o qual deseja gerar um avatar. Pode introduzir vários nomes (incluindo nome próprio, segundo nome e apelido), e o serviço mostrará automaticamente duas letras no avatar. Pode modificar o número de letras através do parâmetro char\_limit indicado abaixo.
</ParamField>

<ParamField query="image_size" type="Integer">
  As dimensões da imagem de avatar quadrada em píxeis. O valor predefinido é 64 píxeis, com tamanhos disponíveis de 6 a 512 píxeis.
</ParamField>

<ParamField query="image_format" type="String">
  O formato preferido para a imagem gerada. O valor predefinido é "png", mas também pode escolher "svg".
</ParamField>

<ParamField query="font_size" type="Float">
  O tamanho da fonte expresso como percentagem de image\_size. O valor predefinido é 0,7, com valores aceitáveis entre 0,1 e 1,0.
</ParamField>

<ParamField query="char_limit" type="Integer">
  O número máximo de caracteres a mostrar no avatar. O valor predefinido é 2. O número real de caracteres mostrados pode ser inferior a este limite, mas nunca superior. A seleção de caracteres prioriza primeiro palavras distintas e depois a segunda letra de palavras distintas.
</ParamField>

<ParamField query="background_color" type="String">
  O código de cor hexadecimal para o fundo. O valor predefinido é #335eea. Ao especificar uma cor hexadecimal, omita o símbolo "#". Por exemplo, \&background\_color=e4704a é válido enquanto \&background\_color=#e4704a não o é.
</ParamField>

<ParamField query="font_color" type="String">
  O código de cor hexadecimal para o texto. O valor predefinido é branco (ffffff). Ao especificar uma cor hexadecimal, omita o símbolo "#". Por exemplo, \&font\_color=e4704a é válido enquanto \&font\_color=#e4704a não o é.
</ParamField>

<ParamField query="is_rounded" type="Boolean">
  Gera uma imagem de avatar circular em vez de quadrada. O valor predefinido é false.
</ParamField>

<ParamField query="is_uppercase" type="Boolean">
  Converte todas as iniciais do avatar em maiúsculas. O valor predefinido é true.
</ParamField>

<ParamField query="is_italic" type="Boolean">
  Aplica estilo itálico a todas as iniciais do avatar. O valor predefinido é false.
</ParamField>

<ParamField query="is_bold" type="Boolean">
  Aplica estilo negrito a todas as iniciais do avatar. O valor predefinido é false.
</ParamField>