Zum Inhalt springen

Konfigurieren der SuccessFactors OData API Authentifizierung im Jitterbit App Builder

SuccessFactors unterstützt den OAuth 2.0 SAML Bearer Assertion-Flow. Dieser Flow bietet eine benutzerbeschränkte Autorisierung und tauscht SAML Assertionen gegen Zugriffstoken aus, wie in der folgenden Spezifikation beschrieben:

https://tools.ietf.org/html/draft-ietf-oauth-saml2-bearer-23

Dieses Dokument behandelt die folgenden Aufgaben:

  1. Registrieren App Builder als SuccessFactors OAuth2-Clientanwendung
  2. Registrieren Sie SuccessFactors als an App Builder Sicherheitsanbieter.
  3. Registrieren Sie den SAP OData-Dienst Datenquellenserver.

Anforderungen

Um fortzufahren, benötigen Sie Folgendes:

  • Ein bestehendes SuccessFactors-Konto.
  • Administratorzugriff auf das SuccessFactors-Konto.
  • Administratorzugriff auf App Builder.

Registrieren App Builder als SuccessFactors OAuth2-Clientanwendung

App Builder muss in SuccessFactors als OAuth2-Clientanwendung registriert werden. Zur Registrierung App Builder als OAuth2-Clientanwendung benötigen Sie die folgenden Informationen:

Beispiel Hinweise
Anwendungsname App Builder Der Anwendungsname ist beliebig. Bei der Registrierung mehrerer Instanzen von App Builder Geben Sie jeder Anwendung als OAuth2-Client einen eindeutigen Namen.
Anwendungs URL https://example.com/App Builder/ Dies ist die App Builder Webstamm. Die URL muss den abschließenden Schrägstrich enthalten.
Allgemeiner Name example.com Dies ist der Host des Webstamms.

Zur Registrierung App Builder als SuccessFactors OAuth2-Clientanwendung:

  1. Melden Sie sich als Administrator bei SuccessFactors an
  2. Navigieren Sie zum Admin Center
  3. Wählen Sie Unternehmenseinstellungen → OAuth 2-Clientanwendungen verwalten
  4. Klicken Sie auf die Schaltfläche Client-Anwendung registrieren
  5. Geben Sie den Anwendungsnamen und die Anwendungs-URL an.
  6. Klicken Sie auf die Schaltfläche X.509-Zertifikat generieren
  7. Geben Sie den Common Name(CN) an
  8. Klicken Sie auf die Schaltfläche Generieren
  9. Klicken Sie auf die Schaltfläche Herunterladen, um das Zertifikat zu speichern
  10. Klicken Sie auf die Schaltfläche Registrieren

Nach der Registrierung weist SuccessFactors einen API-Schlüssel zu. Der API Schlüssel wird zusammen mit dem Zertifikat benötigt, um die restlichen Verfahren abzuschließen.

Zertifikat konvertieren

SuccessFactors generiert ein Zertifikat im PEM-Format; App Builder erfordert ein base64-kodiertes, PKCS#12-formatiertes Zertifikat. Eine vollständige Erörterung dieses Themas liegt außerhalb des Rahmens dieses Dokuments. Als Beispiel kann jedoch das OpenSSL-Befehlszeilenprogramm verwendet werden, um ein Zertifikat von PEM in PKCS#12 zu konvertieren:

openssl pkcs12 -in certificate.pem -export -out certificate.pfx

Beachten Sie, dass Sie aufgefordert werden, ein Passwort einzugeben. Notieren Sie sich das Passwort, da es später benötigt wird.

So kodieren Sie das Zertifikat base64:

openssl base64 -in certificate.pfx -out certificate.txt-A

Weitere Informationen zu SuccessFactors OAuth2 Client Application-Zertifikaten finden Sie im folgenden Dokument:

http://help.sap.com/saphelpiis_cloud4hr/EN/SuccessFactors_HCM_Suite_OData_API_Handbook_en.pdf

Notiz

Zum Zeitpunkt des Schreibens generiert SuccessFactors kein OpenSSL-kompatibles Zertifikat. Um das Zertifikat kompatibel zu machen, öffnen Sie das Zertifikat in einem Texteditor und nehmen Sie die folgenden Änderungen vor:

Ersetzen Sie beide Vorkommen von „ENCRYPTED PRIVATE KEY“ durch „PRIVATE KEY“.

Fügen Sie Zeilenumbrüche so ein, dass keine Zeile länger als 76 Zeichen ist. Beachten Sie, dass es sich dabei um Zeilenumbrüche im Unix-Stil (Zeilenvorschub) handeln muss, nicht um Zeilenumbrüche im Windows oder Internet-Stil (Zeilenvorschub-/Wagenrücklaufpaare).

Registrieren Sie SuccessFactors als an App Builder Sicherheitsanbieter

Um SuccessFactors zu registrieren als an App Builder Sicherheitsanbieter benötigen Sie folgende Informationen:

Beispiel Hinweise
API -Schlüssel Der API Schlüssel wird von SuccessFactors bei der Registrierung der OAuth2-Client-Anwendung zugewiesen (siehe oben).
Signaturzertifikat Das Signaturzertifikat muss ein base64-codiertes PKCS#12-Zertifikat sein, das den privaten Schlüssel enthält. Das Zertifikat kann manuell oder während des Registrierungsprozesses der SuccessFactors OAuth2-Clientanwendung (siehe oben) generiert werden.
Kennwort für Signaturzertifikat Das Kennwort für Signaturzertifikat wird beim Generieren des Zertifikats im PKCS#12-Format zugewiesen.
Firmen-ID Die SuccessFactors-Firmenkennung.
Instanz API URL https://api8.successfactors.com/ SuccessFactors-API URL: „Ihre Endpoint URLs für den Zugriff auf die OData APIs hängen vom Rechenzentrum ab, in dem Ihre SuccessFactors-Instanz gehostet wird.“ Siehe http://help.sap.com/saphelpiis_cloud4hr/EN/SuccessFactors_HCM_Suite_OData_API_Handbook_en.pdf für weitere Informationen.

Notiz

Die URL enthält nicht den Pfad /odata/v2. App Builder wird den Pfad anhängen.

Um SuccessFactors als zu registrieren an App Builder Sicherheitsanbieter:

  1. Melden Sie sich an App Builder als Administrator
  2. Navigieren Sie zur IDE
  3. Klicken Sie auf die Schaltfläche Sicherheitsanbieter
  4. Klicken Sie im Bereich „Datenquellenauthentifizierung“ auf die Schaltfläche + Datenquellenauthentifizierung

  5. Geben Sie Folgendes an:

    • Name: Ein eindeutiger Name des Sicherheitsanbieters.
    • Beispiel: SuccessFactors
    • Typ: SuccessFactors OData

    • Priorität: Eine eindeutige Ganzzahl zwischen 10 und 100. Beachten Sie, dass dieser Wert eindeutig sein muss.

      Beispiel: 40

  6. Klicken Sie auf die Schaltfläche Speichern

  7. Legen Sie die folgenden Eigenschaften fest (Klicken Sie im Eigenschaftenfenster auf die Schaltfläche + Eigenschaft → Wählen Sie den Parameter aus → Geben Sie den Wert ein → Klicken Sie auf das Symbol Speichern):

    • Authentifizierungstyp: Saml
    • CompanyID: Firmen-ID
    • ApiKey: API Schlüssel
    • InstanceApiUrl: URL der Instanz API
    • SigningCertificate: Signaturzertifikat
    • SigningCertificatePassword: Passwort für Signaturzertifikat

  8. Klicken Sie im Bereich „Anbieter“ auf die Schaltfläche Bearbeiten

  9. Aktivieren Sie die Option Aktiviert
  10. Klicken Sie auf die Schaltfläche Speichern

Registrieren des Datenquellenservers des SAP OData-Diensts

Um SuccessFactors zu registrieren als an App Builder Datenquellenserver benötigen Sie die folgenden Informationen:

Beispiel Hinweise
OData Endpoint https://api8.successfactors.com/odata/v2/ SuccessFactors API URL: „Ihre Endpoint URLs für den Zugriff auf die OData APIs hängen vom Rechenzentrum ab, in dem Ihre SuccessFactors-Instanz gehostet wird.“ Siehe http://help.sap.com/saphelpiis_cloud4hr/EN/SuccessFactors_HCM_Suite_OData_API_Handbook_en.pdf für weitere Informationen.
Name des Sicherheitsanbieters SuccessFactors Der Name des Sicherheitsanbieters wie oben angegeben.

Notiz

Seit März 2016 scheint der OData Endpoint einen abschließenden Schrägstrich zu erfordern.

So registrieren Sie SuccessFactors als an App Builder Datenquellenserver:

  1. Melden Sie sich an App Builder als Administrator
  2. Navigieren Sie zur IDE
  3. Wählen Sie die Schaltfläche Datenserver
  4. Klicken Sie im Bereich Datenserver auf die Schaltfläche + Server

  5. Geben Sie Folgendes an:

    • Name: Ein eindeutiger, logischer Servername.
    • Beispiel: SuccessFactors
    • Typ: SuccessFactors

    • URL: {OData Endpoint}

      Example: https://api8.successfactors.com/odata/v2

    • Beispiel: https://api8.successfactors.com/odata/v2

    • Sicherheitsanbieter: {Security Provider Name}

  6. Klicken Sie auf die Schaltfläche Speichern

Sobald der Datenquellenserver registriert wurde, klicken Sie auf die Schaltfläche Verbindung testen, um sicherzustellen, dass alles richtig konfiguriert ist. Möglicherweise werden Sie zu diesem Zeitpunkt aufgefordert, sich bei Okta anzumelden.

Fehlerbehebung

Eine Liste der SuccessFactors OAuth 2.0-Fehlerantworten finden Sie auf der folgenden Seite:

http://help.sap.com/saphelpiis_cloud4hr/EN/SuccessFactors_HCM_Suite_OData_API_Handbook_en.pdf

Der folgende Anhang „OAuth 2.0-bezogene Fehlermeldungen“ enthält zusätzliche Fehler:

http://help.sap.com/saphelpiis_cloud4hr/EN/SF_HCMS_OData_API_User_en/2ff9b29c3b774ebdaf367526a5444072.html

Weitere Informationen zur Fehlerbehebung finden Sie im Folgenden:

Sicherheitsanbieter - Erfolgsfaktoren OData

„Entweder ist der Server nicht erreichbar oder die Verbindungsinformationen sind falsch.“ beim Testen der Verbindung

Stellen Sie sicher, dass die URL des Datenquellenservers mit einem Schrägstrich endet. Beispiel:

https://api8.successfactors.com/odata/v2/

Seit März 2016 erfordert SuccessFactors einen abschließenden Schrägstrich.

„Der Zugriff auf die OData API mittels Basisauthentifizierung oder externem OAuth auf Nicht-API -Servern ist verboten.“ beim Testen der Verbindung

Möglicherweise wurde der API Endpoint durch einen neuen Endpoint ersetzt. Beispielsweise wurden die folgenden Endpoints ersetzt:

  • Im November 2015 wurde der API Endpoint https://salesdemo4.successfactors.com/ wurde ersetzt durch https://apisalesdemo4.successfactors.com/.
  • Im März 2016 wurde der API Endpoint https://hcm8preview.sapsf.com/ wurde ersetzt durch https://api8preview.sapsf.com/.