Zum Inhalt springen

Konfigurieren der SuccessFactors OData API-Authentifizierung in Jitterbit App Builder

SuccessFactors unterstützt den OAuth 2.0 SAML Bearer Assertion Flow. Dieser Flow bietet benutzergebundene Autorisierung durch den Austausch von SAML-Assertionen gegen Zugriffstoken wie in der folgenden Spezifikation beschrieben:

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

In diesem Dokument werden die folgenden Aufgaben behandelt:

  1. App Builder als SuccessFactors OAuth2-Clientanwendung registrieren
  2. SuccessFactors als Sicherheitsanbieter von App Builder registrieren.
  3. Den SAP OData Service-Datenquellenserver registrieren.

Anforderungen

Um fortzufahren, benötigen Sie Folgendes:

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

App Builder als SuccessFactors OAuth2-Clientanwendung registrieren

App Builder muss in SuccessFactors als OAuth2-Clientanwendung registriert werden. Um App Builder als OAuth2-Clientanwendung zu registrieren, benötigen Sie die folgenden Informationen:

Beispiel Hinweise
Anwendungsname App Builder Der Anwendungsname ist willkürlich. Wenn mehrere Instanzen von App Builder als OAuth2-Clientanwendungen registriert werden, geben Sie jeder einen eindeutigen Namen.
Anwendungs-URL https://example.com/Vinyl/ Dies ist das App Builder-Webroot. Die URL muss einen abschließenden Schrägstrich enthalten.
Common Name example.com Dies ist der Hostnameteil des Webroot.

So registrieren Sie 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 Company Settings → Manage OAuth 2 Client Applications
  4. Klicken Sie auf die Schaltfläche Register Client Application
  5. Geben Sie den Application Name und die Application URL an
  6. Klicken Sie auf die Schaltfläche Generate X.509 Certificate
  7. Geben Sie den Common Name(CN) an
  8. Klicken Sie auf die Schaltfläche Generate
  9. Klicken Sie auf die Schaltfläche Download, um das Zertifikat zu speichern
  10. Klicken Sie auf die Schaltfläche Register

Nach der Registrierung weist SuccessFactors einen API-Schlüssel zu. Der API-Schlüssel und das Zertifikat werden benötigt, um die verbleibenden Verfahren abzuschließen.

Zertifikat konvertieren

SuccessFactors generiert ein PEM-formatiertes Zertifikat. App Builder erfordert ein Base64-codiertes Zertifikat im PKCS#12-Format. Eine ausführliche Erörterung dieses Themas liegt außerhalb des Umfangs dieses Dokuments. Beispielsweise lässt sich das OpenSSL-Befehlszeilen-Dienstprogramm verwenden, um ein Zertifikat von PEM in PKCS#12 zu konvertieren:

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

Beachten Sie, dass Sie zur Eingabe eines Passworts aufgefordert werden. Notieren Sie sich das Passwort, da es später benötigt wird.

So codieren Sie das Zertifikat mit Base64:

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

Weitere Informationen zu SuccessFactors OAuth2-Clientanwendungszertifikaten finden Sie im folgenden Dokument:

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

Hinweis

Zum Zeitpunkt der Erstellung dieses Dokuments generiert SuccessFactors kein mit OpenSSL kompatibles Zertifikat. Um das Zertifikat kompatibel zu machen, öffnen Sie das Zertifikat in einem Texteditor und nehmen die folgenden Änderungen vor:

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

SuccessFactors als App Builder-

Sicherheitsanbieter registrieren {: #register-successfactors-as-an-app-builder-security-provider }

Um SuccessFactors als App Builder- Sicherheitsanbieter zu registrieren, benötigen Sie die folgenden 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-kodiertes, PKCS#12-Zertifikat mit dem privaten Schlüssel sein. Das Zertifikat kann manuell oder während des Registrierungsvorgangs der SuccessFactors OAuth2-Client-Anwendung generiert werden (siehe oben).
Signaturzertifikat-Passwort Das Passwort des Signaturzertifikats wird bei der Generierung des im PKCS#12-Format formatierten Zertifikats zugewiesen.
Unternehmens-ID Der SuccessFactors-Unternehmensidentifikator.
Instanz-API-URL https://api8.successfactors.com/ SuccessFactors-API-URL: „Ihre Endpunkt-URLs für den Zugriff auf die OData-APIs hängen vom Rechenzentrum ab, das Ihre SuccessFactors-Instanz hostet." Weitere Informationen finden Sie unter http://help.sap.com/saphelpiis_cloud4hr/EN/SuccessFactors_HCM_Suite_OData_API_Handbook_en.pdf.

Hinweis

Die URL enthält nicht den Pfad /odata/v2. App Builder fügt den Pfad an.

Um SuccessFactors als App Builder- Sicherheitsanbieter zu registrieren:

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

  5. Geben Sie folgende Informationen an:

    • Name: Ein eindeutiger Sicherheitsanbieter-Name.
    • Beispiel: SuccessFactors
    • Typ: SuccessFactors OData

    • Priorität: Eine eindeutige ganze Zahl zwischen 10 und 100. Dieser Wert muss eindeutig sein.

      Beispiel: 40

  6. Klicken Sie auf die Schaltfläche Speichern

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

  8. AuthenticationType: Saml

  9. CompanyID: Unternehmens-ID
  10. ApiKey: API-Schlüssel
  11. InstanceApiUrl: Instance-API-URL
  12. SigningCertificate: Signaturzertifikat

  13. SigningCertificatePassword: Signaturzertifikat-Passwort

  14. Klicken Sie auf die Schaltfläche Bearbeiten im Bereich „Anbieter"

  15. Aktivieren Sie die Option Aktiviert
  16. Klicken Sie auf die Schaltfläche Speichern

SAP OData-Dienst-Datenquelle registrieren

Um SuccessFactors als App-Builder-Datenquellen-Server zu registrieren, benötigen Sie folgende Informationen:

Beispiel Hinweise
OData-Endpunkt https://api8.successfactors.com/odata/v2/ SuccessFactors-API-URL: „Ihre Endpunkt-URLs für den Zugriff auf die OData-APIs hängen von dem Rechenzentrum ab, das Ihre SuccessFactors-Instanz hostet." Weitere Informationen finden Sie unter http://help.sap.com/saphelpiis_cloud4hr/EN/SuccessFactors_HCM_Suite_OData_API_Handbook_en.pdf.
Sicherheitsanbieter-Name SuccessFactors Der Name des Sicherheitsanbieters wie oben angegeben.

Hinweis

Seit März 2016 erfordert der OData-Endpunkt offenbar einen nachgestellten Schrägstrich.

Um SuccessFactors als App-Builder-Datenquellen-Server zu registrieren:

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

  5. Geben Sie folgende Angaben ein:

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

    • URL: {OData-Endpunkt}

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

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

    • Sicherheitsanbieter: {Sicherheitsanbieter-Name}

  6. Klicken Sie auf die Schaltfläche Speichern

Nachdem der Datenquellen-Server registriert wurde, klicken Sie auf die Schaltfläche Verbindung testen, um sicherzustellen, dass alles korrekt konfiguriert ist. Sie werden möglicherweise aufgefordert, sich zu diesem Zeitpunkt mit 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 weitere Fehler:

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

Weitere Informationen zur Fehlerbehebung finden Sie hier:

Security provider - successfactors OData

„Entweder ist der Server nicht verfügbar oder die Verbindungsinformationen sind falsch", wenn die Verbindung getestet wird

Stellen Sie sicher, dass die Datenquellen-Server-URL mit einem Schrägstrich endet. Zum Beispiel:

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

Seit März 2016 erfordert SuccessFactors einen nachgestellten Schrägstrich.

„Der Zugriff auf die OData-API mit Standardauthentifizierung oder externem OAuth auf nicht-API-Servern ist nicht zulässig." beim Testen der Verbindung

Es ist möglich, dass der API-Endpunkt durch einen neuen Endpunkt ersetzt wurde. Beispielsweise wurden die folgenden Endpunkte ersetzt:

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