Zum Hauptinhalt springen
GET
/
v1
Avatars-API
curl --request GET \
  --url https://avatars.cleariflow.com/v1
Die Nutzung ist unkompliziert: Übergeben Sie Ihren api_key zusammen mit einem name, und das System erstellt ein Avatar-Bild mit den Initialen des angegebenen Namens.

​
Erste Schritte

​
REST

Die Avatars-API folgt dem gleichen Architekturmuster wie alle Cleariflow-Dienste und ist um REST-Prinzipien herum aufgebaut. Sie verwendet vorhersehbare, ressourcenorientierte URLs und HTTP-Statuscodes zur Fehlerkommunikation.

​
HTTPS

Die Avatars-API erfordert, dass alle Datenübertragungen mit TLS 1.2 oder höher verschlüsselt werden.

​
API-Versionen

Jeder Cleariflow-Dienst ist versioniert. Die Avatars-API befindet sich derzeit in Version 1.

​
Ihr API-Schlüssel

Ihr API-Schlüssel ist Ihre ausschließliche Authentifizierungsberechtigung für den Zugriff auf die Cleariflow Avatars-API. Beachten Sie, dass jeder Cleariflow-Dienst einen eigenen API-Schlüssel hat — Sie benötigen also separate Schlüssel für Avatars und E-Mail-Validierung. Zur Authentifizierung Ihrer Anfragen fügen Sie Ihren API-Schlüssel in die Basis-URL ein.

​
Basis-URL

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

​
Validierungs-Endpunkt

Die Cleariflow Avatars-API benötigt nur Ihren eindeutigen API-Schlüssel und den Namen des Nutzers zur Avatar-Erstellung: 
https://avatars.cleariflow.com/v1/
? api_key = YOUR_UNIQUE_API_KEY
& name = Alexander Rodriguez
Diese Anfrage wurde erfolgreich verarbeitet — das resultierende Avatar für den angegebenen Namen erscheint unten: Avatar für Alexander Rodriguez

​
Anfrageparameter

​
api_key
String
erforderlich
Ihr eindeutiger API-Schlüssel. Beachten Sie, dass jeder Nutzer für jeden Cleariflow-Dienst eigene API-Schlüssel hat — Ihr Avatars-API-Schlüssel funktioniert z. B. nicht für die IP-Geolokalisierungs-API.
​
name
String
erforderlich
Der Name, für den ein Avatar erstellt werden soll. Sie können mehrere Namen eingeben (Vor-, Mittel- und Nachname) — der Dienst zeigt automatisch zwei Buchstaben im Avatar. Die Anzahl der Buchstaben lässt sich mit dem Parameter char_limit unten anpassen.
​
image_size
Integer
Die Abmessungen des quadratischen Avatar-Bildes in Pixeln. Standardmäßig 64 Pixel; verfügbare Größen von 6 bis 512 Pixeln.
​
image_format
String
Das gewünschte Format des generierten Bildes. Standardmäßig „png”; alternativ „svg”.
​
font_size
Float
Die Schriftgröße als Prozentsatz von image_size. Standardmäßig 0,7; zulässige Werte zwischen 0,1 und 1,0.
​
char_limit
Integer
Die maximale Anzahl anzuzeigender Zeichen im Avatar. Standardmäßig 2. Die tatsächlich angezeigte Anzahl kann geringer, aber nie größer sein. Die Zeichenauswahl priorisiert unterschiedliche Wörter, dann den zweiten Buchstaben unterschiedlicher Wörter.
​
background_color
String
Der hexadezimale Farbcode für den Hintergrund. Standardmäßig #335eea. Bei Angabe einer Hex-Farbe das „#“-Symbol weglassen. Beispiel: &background_color=e4704a ist gültig, &background_color=#e4704a ist ungültig.
​
font_color
String
Der hexadezimale Farbcode für den Text. Standardmäßig weiß (ffffff). Bei Angabe einer Hex-Farbe das „#“-Symbol weglassen. Beispiel: &font_color=e4704a ist gültig, &font_color=#e4704a ist ungültig.
​
is_rounded
Boolean
Erzeugt ein kreisförmiges statt quadratisches Avatar-Bild. Standardmäßig false.
​
is_uppercase
Boolean
Wandelt alle Initialen im Avatar in Großbuchstaben um. Standardmäßig true.
​
is_italic
Boolean
Wendet Kursivschrift auf alle Initialen im Avatar an. Standardmäßig false.
​
is_bold
Boolean
Wendet Fettschrift auf alle Initialen im Avatar an. Standardmäßig false.