Hinzufügen eines Benutzeravatars über das Vtiger REST-API

Hinzufügen eines Benutzeravatars über das Vtiger REST-API

In Vtiger REST-API existiert die Methode Revise, um Benutzerdaten abzurufen. Dabei fällt jedoch auf, dass die Antwort zwar den Dateinamen des Avatars im Feld imagename enthält, jedoch weder den Dateipfad noch die Bilddaten selbst. Ohne zusätzliche Anpassungen ist es somit unmöglich, den Avatar auf einer Website anzuzeigen.

Anpassung der Datei Retrieve.php

Um dies zu beheben, müssen Änderungen in der Datei include/Webservices/Retrieve.php vorgenommen werden. Fügen Sie nach der Zeile
$entity = $handler->retrieve($id);

folgenden Codeblock ein:

if ($entityName === 'Users' && $entity['imagename']) {
    $recordIds = explode('x', $id);
    $userModel = Users_Record_Model::getInstanceById($recordIds[1], $entityName);
    $images = $userModel->getImageDetails();
    if (isset($images[0])) {
        $entity['image_details'] = $images[0];
    }
}

Dieser Code prüft, ob es sich um einen Benutzerdatensatz mit vorhandenem Avatar handelt. Falls ja, werden die Bilddetails (z. B. Pfad, URL) ausgelesen und der API-Antwort hinzugefügt.

Überprüfung des Ergebnisses

Nach der Anpassung enthält die API-Antwort neben imagename zusätzlich das Objekt image_details mit folgenden Informationen:

"image_details": {
    "id": "78",
    "orgname": "borka.jpeg",
    "path": "storage/2023/May/week4/78",
    "name": "borka.jpeg",
    "url": "http://vtiger.test:8000/public.php?fid=78&key=ca0ed8e8892736515860bec11edb4b39"
}

Die url ermöglicht nun den direkten Zugriff auf das Bild. Integrieren Sie diese URL in Ihre Website, um den Avatar anzuzeigen.

Fazit

Durch diese einfache Anpassung erweitern Sie das Vtiger-API um kritische Bildinformationen. Entwickler können so nahtlos Avatars in Benutzeroberflächen einbinden und personalisierte Erfahrungen schaffen. Die Änderung ist schnell umgesetzt, bietet aber erhebliche Vorteile für die Datenkontrolle und UI-Gestaltung.

Tipp: Testen Sie die API-Antwort nach der Code-Anpassung gründlich, um sicherzustellen, dass die Bild-URLs korrekt generiert werden.