0% found this document useful (0 votes)
223 views3 pages

SF Integration With ODATA

OData (Open Data Protocol) allows for RESTful integration of HR data from SuccessFactors using HTTP. It requires enabling the OData API in provisioning and creating an SFAPI user with the proper permissions. Authentication uses HTTP Basic Authentication with the username formatted as "Username@CompanyID:Password" and the header encoded to Base64. Configuring Postman involves adding the URL and encoding the authentication credentials in the Basic Auth tab.

Uploaded by

mastersaphr
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOC, PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
223 views3 pages

SF Integration With ODATA

OData (Open Data Protocol) allows for RESTful integration of HR data from SuccessFactors using HTTP. It requires enabling the OData API in provisioning and creating an SFAPI user with the proper permissions. Authentication uses HTTP Basic Authentication with the username formatted as "Username@CompanyID:Password" and the header encoded to Base64. Configuring Postman involves adding the URL and encoding the authentication credentials in the Basic Auth tab.

Uploaded by

mastersaphr
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOC, PDF, TXT or read online on Scribd
You are on page 1/ 3

ODATA testing using POSTMAN

OData (Open Data Protocol) is built on protocols like HTTP following the REST methodologies
for data transfer. With OData API, SuccessFactors is leading the league in providing Rest-ful
integration services for your HR data in cloud.
Prerequisites:
1. Enable Odata API in Provisioning.
2. Create SFAPI user in Provisioning.
3. Provide Role Based Permission (RBP) authorization to the SFAPI user. If you are not
using RBP, you may use User based permission.
4. Postman or any other REST client.
SuccessFactors URL:
SuccessFactors URLs or endpoints are specific to data centers. You should always use the URL
specific to your data center.
https://salesdemo4.successfactors.com/odata/v2 Or
https://<data center>.successfactors.com/odata/v2
OData Authentication
One of the authentication methods OData uses to access data is HTTP Basic Authentication.
HTTP Basic Authentication requires the authorization header organized in a certain way:
Username@CompanyID:Password. The Company ID is your unique Company ID which you
use to log into your SuccessFactors instance. Once the header is created, it is encoded in Base64
before being sent over.
Postman Configuraiton
1. The first step is to configure add the URL and the Basic Authentication header. Use the
Normal tab to enter the URL.

1. Use the Basic Auth tab to enter the credentials. Once done, click on Refresh Headers
which adds the Base64 format of header to your request. Note that as mentioned in the

OData Authentication section above, you dont need to put an explicit colon between
CompanyID and Password for Postman client. This client automatically adds a colon
before converting the entire header to Base64.

1. Once the Basic Auth details are entered, the configuration is complete to request the first
set of data. The removed section in Red below is the Base64 format of the
authentication header.

1. The list of entities to access data can be retrieved using $metadata operation.
https://<data center>.successfactors.com/odata/v2/$metadata

You might also like