Überblick über die API-Technologie
EC-API-Konfiguration einrichten
Verwenden von OData-API-Aufrufen und -Tools
EC-OData-API-Funktionen optimieren
EC-OData-Schreiboperation durchführen
Integrations-Center verwalten
Externe Ereignisbenachrichtigung konfigurieren
Monitoring-APIs
Anhang wird analysiert

API-Technologie erkunden

Objective

After completing this lesson, you will be able to rufen Sie zurück, wann welches von SAP SuccessFactors unterstützte API verwendet werden soll.

Einführung

Im Folgenden finden Sie eine grundlegende Übersicht über die EC-API-Technologie.

Aufgezeichnetes Webinar: Einführung in Employee Central und OData API

Überblick über die API-Technologie

API-Erste Strategie

Das Framework für das Intelligente Unternehmen

OData bietet Partnern und Kunden ein konsistentes API-Erlebnis für das intelligente Unternehmen.

  • Integrieren Sie intelligente Technologien mit konsistenten Techniken in Erweiterungen.
  • Die gleichen Tools und Fähigkeiten gelten für alle Produkte.
  • Nutzen Sie vorhandene Anlagen, um die Vision der intelligenten Suite schnell umzusetzen.
  • OData ist der Architekturstandard von SAP.

SAP-Framework mit intelligenter Suite, digitaler Plattform, KI/ML, IoT, Analysen und Komponenten wie Customer Experience und Cloud Platform.

API-First Architectural Vision

Externe Anwendung in/aus SAP-SuccessFactors-System - Datenreplikation

  • Drittanbietersystem repliziert Daten aus oder in ein SAP-SuccessFactors-System
  • In der Regel beteiligte Middleware
  • Technische Benutzer, die für die Replikation verwendet werden
SAP-Architektur mit HANA, OData-APIs, Fiori UI5, Mobile, Chatbots, Integrationen, Erweiterungen und Serviceschicht.

Externe Anwendung für SAP-SuccessFactors-System in Echtzeit - UI-Integration

  • Anwendungszugriff auf Daten in Echtzeit aus einem SAP-SuccessFactors-System
  • In der Regel beteiligte Anwendungsplattformen
  • Zugriff auf Definierte Benutzer

Vorteile eines API-First-Ansatzes

Höhere Qualität

  • APIs sind mit dem Automatisierungs-Framework (AAF v2) und metadatengesteuerten Tests einfacher und kostengünstiger zu testen.
  • Die weitverbreitete Nutzung von Shared Services minimiert die Wahrscheinlichkeit von Testfluktuationen.
  • API-Daten- und Konfigurationsservices sind für die testgesteuerte Entwicklung (TDD) einfacher nachvollziehbar
  • UX-Tests müssen nur die Controller-Logik testen, da die zugrunde liegenden Services bereits getestet wurden.

Time-to-Market/Cost of Ownership

  • Verbessert die Markteinführungszeit für mobile Geräte, Desktops, Partneranwendungen und kundenspezifische Anwendungen
  • DSGVO, CypherCloud, Verschlüsselung und andere Funktionen, die mit einem zentralen Satz von Services auf einem gemeinsamen Framework einfacher implementiert werden können
  • Keine Doppelpflege - nur ein einziger Satz von Geschäftslogik wird gepflegt.
  • Funktionale Verbesserungen profitieren von allen Anwendungen

Skalierbarkeit/Stabilität

  • Vermittlung, Überwachung, Analyse und Drosselung der API über SAP API Management in unseren Rechenzentren
  • Verbesserungen der API-Performance profitieren von allen Anwendungen
  • APIs sind für jede Microservice-Architektur unerlässlich.

Verfügbare API/Integrationstechnologien für EC

Integrations-/API-Entwicklung

Import/Export: CSV-Datei (Automatisierung über FTP möglich)

SOAP-APIs

  • Zusammengesetzter Mitarbeiter: Spezialisierter SOAP-Service für Datenreplikation (schreibgeschützt)

OData-APIs

  • EC-OData-Lese-APIs für UI-Nutzung und -Replikation
  • EC-OData-Upsert-APIs für Datenreplikation
  • MDF-OData-Lese-/Schreib-APIs für UI-Nutzung und -Replikation

Mitarbeiterbasiert - zusammengesetztes Mitarbeiter-API

Mitarbeiterbasiert - zusammengesetztes Mitarbeiter-API - I

Zusammengesetzter Mitarbeiter

Flussdiagramm, das die Beziehungen zwischen SAP-Grundlagenobjekten veranschaulicht, einschließlich Personen-, Beschäftigungs- und biografischer Informationen, zusammen mit Stellen- und Vergütungsdetails.

Zurück zum Entity-Relation-Diagramm wird angezeigt, dass das Compound-Employee-API eine Reihe von Entitäten enthält, die von einer orangefarbenen Linie umgeben sind. Compound Employee API ist eine Art EC-SOAP-API-Technologie, die sich auf die Replikation von Mitarbeiterstammdaten aus Employee Central konzentriert.

Mitarbeiterbasiert - zusammengesetztes Mitarbeiter-API - II

Anforderung:

XML-Code-Snippet zum Abfragen von Personen- und persönlichen Informationen aus CompoundEmployee, wobei person_id_external gleich 'greinhard3' ist.

Antwort:

XML-Daten, die CompoundEmployee-Details anzeigen.

Wenn Sie einen zusammengesetzten Mitarbeiter abfragen, ist die Abfrageklausel nicht mehr Felder, sondern der Entitätsname (Person, personal_information), der im Vergleich zum direkten API von SAP SuccessFactors verwendet wird.

Mitarbeiterbasiert - EC OData API - I

EC-OData-APIs, die Navigationen verwenden, einschließlich MDF

SAP-SuccessFactors-Objekte: Person, Beschäftigung und Grundlage mit Verbindungen zu Stelle, Vergütung und biografischen Details

OData-APIs unterstützen die Navigation für zugehörige Entitäten. Basierend auf der definierten Beziehung werden automatisch Navigationen von der Quellentität zu den Zielentitäten angelegt. Navigationen in einer Entität stellen Assoziationen zwischen Entitäten dar. Jede Entität kann die folgenden Eigenschaften haben.

  • Wirksamkeitsdatum
  • Betriebswirtschaftliche Schlüssel
  • Erforderliches/nullwertfähiges Attribut
  • Verarbeitungsparameter für Upsert

Mitarbeiterbasiert - EC-OData-API - II

Sehen Sie sich diese API-Anforderung und -Antwort an. Wir können vorhandene Employee-Central-Entitäten (personalInfoNav) einfach erweitern, indem wir die Erweiterungsfunktion verwenden und EC-Kundenerweiterungen für Partner und Kunden erstellen. Mit MDF können Sie Kundenobjekte und die zugehörige Anwendungslogik nach Bedarf an die Anforderungen Ihres Kunden anpassen.

Anforderung:

https://salesdemo4.successfactors.com:443/odata/v2/PerPerson?$format=json &$select=personIdExternal,dateOfBirth, personalInfoNav/startDate, personalInfoNav/firstName, personalInfoNav/lastName, personalInfoNav/customString1&$expand=personalInfoNav &$filter=IdpersonExternal%20eq%20'greinhard3‘

Antwort:

JSON-Daten-Snippet, das persönliche Informationen anzeigt.

Ihre Optionen und Gründe, wann Sie sich entscheiden sollten

Verwendung von Importen/Exporten…

  • Für die Erstdatenübernahme oder wenn Sie keine APIs (SOAP oder OData) verwenden können.

Wann OData und wann SOAP verwendet wird...

  • Wenn Sie RBB und gleichzeitigen Benutzerzugriff verwenden möchten, um eigene UIs auf Basis von EC mithilfe einer Erweiterungsplattform zu erstellen, ist OData die Technologie Ihrer Wahl.
  • Wenn Sie auf MDF-Daten zugreifen möchten, ist OData die einzige Technologie Ihrer Wahl.
  • Für die Datenreplikation mit einem technischen Benutzer (Lesen oder Schreiben) können sowohl SOAP als auch OData verwendet werden. Wir empfehlen jedoch, OData zu verwenden, da OData eine bessere Abdeckung von Entitäten bietet.

Wann soll das zusammengesetzte SOAP-API verwendet werden?

  • Wenn Sie für die Mitarbeiterreplikation Delta, Snapshot oder nur modifizierte Mitarbeiter lesen möchten.
  • Wenn Sie nur Mitarbeiterstammdaten lesen möchten (CE unterstützt kein Schreiben).

SAP-Hilfedokumentation

Highlights der Lösung

OData:

  • Standardisiertes API gemäß der OData-V2-Spezifikation
  • Benutzerdefinierte konfigurierbare Objekte werden mit CRUD-OData-APIs ausgeliefert.
  • OData-APIs reagieren auf Datenmodelländerungen
  • OData-APIs ermöglichen die Navigation durch das Datenmodell mit $expand
  • Zieltechnologie sowohl für Integrations- als auch für UI-Anwendungsfälle
  • Unterstützung benutzerbasierter Berechtigungen
  • OAuth und Standardauthentifizierung möglich

SOAP-API:

  • Employee Central bietet für die Mitarbeiterdatenreplikation ein leistungsfähiges SOAP-Interface (schreibgeschützt).
  • Mehrere Modi verfügbar, z.B. vollständige Übertragung, Delta, Periodendelta und Snapshot
  • Optimiert für hohe Datenlasten

Weitere Informationen:

SAP-SuccessFactors-Plattform | SAP Help Portal

Veraltete Technologie

SOAP-Interface

  • Alle Ad-hoc-Berichte
  • PerDirectDeposit
  • Zusammengesetzter Mitarbeiter – alle direkten SFAPIs ab August 2018

Dateibasierte Importe

  • PerDirectDeposit