Saltar para o conteúdo principal
GET
/
v1
API de avatares
curl --request GET \
  --url https://avatars.cleariflow.com/v1
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: Avatar para Alexander Rodriguez

​
Parâmetros de pedido

​
api_key
String
obrigatório
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.
​
name
String
obrigatório
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.
​
image_size
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.
​
image_format
String
O formato preferido para a imagem gerada. O valor predefinido é “png”, mas também pode escolher “svg”.
​
font_size
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.
​
char_limit
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.
​
background_color
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 é.
​
font_color
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 é.
​
is_rounded
Boolean
Gera uma imagem de avatar circular em vez de quadrada. O valor predefinido é false.
​
is_uppercase
Boolean
Converte todas as iniciais do avatar em maiúsculas. O valor predefinido é true.
​
is_italic
Boolean
Aplica estilo itálico a todas as iniciais do avatar. O valor predefinido é false.
​
is_bold
Boolean
Aplica estilo negrito a todas as iniciais do avatar. O valor predefinido é false.