Erste Schritte mit der User Interface API

Ein riesiges Plus von Salesforce ist, dass Sie die Plattform so anpassen können, dass Sie zu Ihnen und Ihren Kunden passt. Als wir beschlossen, unsere Benutzeroberfläche neu zu erstellen, haben wir sie nicht nur optisch neu gestaltet, sondern eine leistungsstarke Plattform entwickelt, die Ihnen noch mehr Zugriff und Anpassungsmöglichkeiten für Salesforce bietet. Wir gaben ihr den Namen "Lightning".

Lightning umfasst die Salesforce-Benutzerumgebung (Lightning Experience), die Plattform und das UI-Framework (Lightning Web Component-Framework). Mit Lightning können Sie Salesforce auf der Ebene anpassen, die Ihren Fähigkeiten und Anforderungen entspricht, da Sie hier Zugriff auf verschiedene Schichten der Salesforce-Plattform erhalten. In diesem Modul stellen wir den Zugriff auf die Plattform über die User Interface API vor, die Lightning Experience verwendet, um Daten und Metadaten von Salesforce zu erhalten.

Zum Hintergrund: Für die Entwicklung von Lightning Experience brauchten wir eine neue API. Unsere bestehende API bot nicht die notwendigen Zugriffsmöglichkeiten und war für die Datenintegration und nicht für die Erstellung von Benutzeroberflächen konzipiert worden. Und so wurde an einem warmen, wolkenlosen Tag die User Interface API (auch kurz UI API genannt) geboren.

In enger Zusammenarbeit mit unseren internen Salesforce-Entwicklern ermittelten wir, welche Aufgaben schwierig und zeitaufwändig waren, und lösten diese Probleme. Wir haben diese neue REST-API veröffentlicht, was bedeutet, dass Sie Webanwendungen und mobile Anwendungen mit derselben API erstellen können, die Salesforce zum Erstellen von Lightning Experience und den Salesforce-Anwendungen für Android und iOS verwendet.

Salesforce bietet viele APIs, und es kann schwer sein zu entscheiden, welches Tool jeweils das beste ist. Wenn Sie eine benutzerdefinierte Web- oder mobile Anwendung erstellen und eine Benutzeroberfläche benötigen, mit der Benutzer Salesforce-Datensätze anzeigen, erstellen, bearbeiten und löschen können – eine Benutzeroberfläche, die aussieht und sich verhält wie Salesforce – dann ist die UI API das richtige Mittel.

Wenn Sie eine Benutzeroberfläche erstellen, mit der Benutzer abhängige Auswahllisten und Nachschlagesuchen bearbeiten können, ist die User Interface API definitiv das richtige Mittel. Die User Interface API bietet eine Ressource, die das Ganze deutlich einfacher macht.

Wie bereits erwähnt, nutzt Salesforce die User Interface API zum Erstellen von Lightning Experience. Die UI API wird von einer internen Salesforce-Entwicklergruppe für eine andere interne Salesforce-Entwicklergruppe entwickelt, die Lightning Experience entwickelt. Und wir sind schon total gespannt darauf zu sehen, was Sie damit entwickeln werden!

Seien wir ehrlich: Die Salesforce-Benutzeroberfläche ist komplex. Die richtige Benutzeroberfläche für einen bestimmten Benutzer hängt von verschiedenen Regeln, Berechtigungen und Seitenlayout-Konfigurationen ab. Ein Administrator kann diese Abhängigkeiten ändern und an die Geschäftsanforderungen anpassen. Beispielsweise kann ein Administrator Felder in Seitenlayouts hinzufügen oder entfernen, Felder als Pflichtfelder kennzeichnen und Seitenlayouts Profilen zuweisen.

Früher war es schwierig, eine dynamische Benutzeroberfläche für die Arbeit mit Datensätzen in benutzerdefinierten Anwendungen zu erstellen, da man Code schreiben musste, um die Benutzeroberfläche zu aktualisieren, wenn ein Administrator Metadatenänderungen an der Organisation vorgenommen hat.

Das ist einer der Gründe, aus denen die UI API entwickelt haben und bei jeder Version neue Funktionen hinzufügen. Die UI API macht es einfach, eine benutzerdefinierte Benutzeroberfläche gemäß den Regeln und Berechtigungen innerhalb einer Salesforce-Organisation zu erstellen, da die Benutzeroberfläche auf Metadatenänderungen zur Laufzeit reagiert. Das möchten wir sicherheitshalber noch einmal wiederholen: Sie müssen Ihre Anwendung nicht ändern, wenn ein Administrator Berechtigungen, Layouts, Feldebenensicherheit oder Freigaberegeln ändert. Sie müssen noch nicht einmal Code schreiben, der nach diesen Dingen sucht – die UI API erledigt das für Sie.

Bevor es die UI API gab, mussten Sie viele Aufrufe durchführen, um die notwendigen Informationen für das Layout (wo sich die Felder auf der Seite befinden), die Metadaten (welche Felder hat ein Objekt, und sind sie erforderlich) und die Datensatz (was sind die Feldwerte) zu erhalten. Heute führt die UI API diese Aufrufe für Sie durch und gibt Ihnen eine einfach zu analysierende Antwort: Die API erledigt die Arbeit einer Layout-Rendering-Engine, so dass Sie nicht selbst eine erstellen müssen. Ihr Liegestuhl (oder Snowboard oder Garten oder...) wartet.

Ach ja: Für die UI API gelten die gleichen API-Obergrenzen wie für die Enterprise-API, Sie müssen sich also keine Gedanken darüber machen, neue Methoden zur Nachverfolgung von API-Obergrenzen lernen zu müssen.

Verwenden Sie die User Interface API nicht für die Systemintegration. Und auch nicht zum Erstellen einer automatisierten Integration zum Hochladen oder Extrahieren von Daten. Und auch nicht zum Hochladen oder Extrahieren von Daten als Massenvorgang. Verwenden Sie für diese Aufgaben die Enterprise-API oder die Bulk-API.

Verwenden Sie beim Erstellen von Lightning-Webkomponenten die UI API nicht direkt, sondern Lightning Data Service (LDS).

Der LDS setzt auf der User Interface API auf, bietet aber auch Caching für Antworten und Aktualisierungen für alle Datensätze, auf die sich Datenänderungen auswirken. Wenn Sie den LDS verwenden, müssen Sie sich nicht um REST-Aufrufe und das Caching von Ergebnissen kümmern, da der LDS dies für Sie übernimmt. Und wenn sich Daten ändern, aktualisiert der LDS alle relevanten Komponenten. Der LDS verhindert nicht nur inkonsistente Daten zwischen Komponenten, sondern ermöglicht es dem Benutzer auch, offline zu arbeiten, da die Daten synchronisiert werden, sobald er wieder online geht. Der LDS ist cool.

Und, schließlich und endlich, verwenden Sie die User Interface API nicht dazu, die gesamte Salesforce-UI neu zu erstellen. Warum sollten Sie das auch tun wollen?

Die UI API-Ressourcen lassen sich in mehrere Kategorien unterteilen. Dieses Trailhead-Modul befasst sich eingehend mit den Ressourcen für Datensätze und Layouts, wir gehen jetzt aber am besten schnell einige der anderen Kategorien durch, damit Sie eine Vorstellung von den Möglichkeiten bekommen. Eine vollständige Liste der Ressourcen finden Sie im User Interface Developer Guide.

Tipp

In diesem Modul werden die Begriffe Ressource und Endpunkt synonym verwendet.

/ui-api/record-ui/{recordIds}

/ui-api/layout/{objectApiName}
/ui-api/object-info/{objectApiName}
/ui-api/records/{recordId}

/ui-api/record-defaults/create/{objectApiName}
/ui-api/record-defaults/clone/{recordId}

/ui-api/object-info/{objectApiName}/picklist-values/{recordTypeId}

/ui-api/list-ui/${listViewId}
/ui-api/list-ui/${objectApiName}/${listViewApiName}

/ui-api/list-info/${listViewId}
/ui-api/list-info/${objectApiName}/${listViewApiName}
/ui-api/list-records/${listViewId}
/ui-api/list-records/${objectApiName}/${listViewApiName}

/ui-api/actions/global
/ui-api/actions/record/${recordIds}
/ui-api/actions/record/${recordId}/record-edit
/ui-api/actions/record/${recordId}/related-list/${relatedListIds}
// There are more actions resources! Check the User Interface API Developer Guide! 

/ui-api/favorites
/ui-api/favorites/${favoriteId}
/ui-api/favorites/batch
/ui-api/favorites/${favoriteId}/usage

/ui-api/lookups/{objectApiName}/{fieldApiName}
/ui-api/lookups/{objectApiName}/{fieldApiName}/{targetApiName}