【原】使用SAP API portal进行SAP SuccessFactors的API测试

汪子熙 2020-02-19

展开全文

登录api., 根据关键字SuccessFactors找到对应的API目录：

找到foundation/Platform级别的API，进入之后，

选择User Management:

点击Logon，以使用API控制台自带的控制功能：

点击Try Out, 就可以像使用postman一样，使用这个API控制台自带的测试功能了：

$filter string里可以测试这个OData API的filter操作：

从测试结果可以发现，firstName为Sami的user，在这个sandbox系统里的user ID为50004：

点击Show API Key，拿到一个API key，这样就能在该API控制台以外的地方调用API.

点击Code Snipet，可以把自动生成的API调用代码复制下来，直接粘贴到应用里使用。

点击Curl，获得使用工具curl进行测试的命令行：

curl --request GET --url "https://sandbox.api./successfactors/odata/v2/User" --header "APIKey: e9ZLBOfexchhHN" --header "Accept: application/json" --header "Content-Type: application/json"

curl --request GET --url "https://sandbox.api./successfactors/odata/v2/User" --header "APIKey: e9ZLBOkMUexchhHN" --header "Accept: application/json" --header "Content-Type: application/json"

API endpoint for API sandbox

Optional query parameters: "skip"

To view the complete list of query parameters, see its API definition.

Available API Endpoints

https://api2./odata/v2

https://apisalesdemo2./odata/v2

https://api2preview./odata/v2

https://api4./odata/v2

https://apisalesdemo4./odata/v2

https://api4preview./odata/v2

https://api5./odata/v2

https://api8./odata/v2

https://apisalesdemo8./odata/v2

https://api8preview./odata/v2

https://api10./odata/v2

https://api10preview./odata/v2

https://api012./odata/v2

https://apirot./odata/v2

https://api12preview./odata/v2

https://api15./odata/v2

https://api16./odata/v2

https://api17preview./odata/v2

https://api17./odata/v2

https://api18preview./odata/v2

https://api18./odata/v2

得到的结果:

也可以通过select操作，让API只返回firstName和lastName两个字段的值：
curl --request GET --url "https://sandbox.api./successfactors/odata/v2/
User,UserPermissions/User?%24top-5&%24select=firstName%2ClastName" --header 'APIKey: e9ZLBOXsAfkMUexchhHN' --header 'Accept: application/ison' --header "Content-Type: application/ison"

curl --request GET --url "https://sandbox.api./successfactors/odata/v2/User,UserPermissions/User?%24top-5&%24select=firstName%2ClastName" --header "APIKey: e9ZibykWXsAfkMUexchhHN" --header "Accept: application/json" --header "Content-Type: application/json"

在SAP UI5应用里消费API的代码：

//Create JSON Model with URLvar oModel = new sap.ui.model.json.JSONModel();//API Key for API Sandboxvar sHeaders = {"Content-Type":"application/json","Accept":"application/json","APIKey":"e9ZLBOfIplCOnibykWXsAfkMUexchhHN"};//Available Security Schemes for productive API Endpoints//Basic Authentication//Basic Auth : provide username:password in Base64 encoded in Authorization header//sending request//API endpoint for API sandbox oModel.loadData("https://sandbox.api./successfactors/odata/v2/User", null, true, "GET", null, false, sHeaders);//Optional query parameters: "$top" , "$skip"//To view the complete list of query parameters, see its API definition.//Available API Endpoints//https://api2./odata/v2//https://apisalesdemo2./odata/v2//https://api2preview./odata/v2//https://api4./odata/v2//https://apisalesdemo4./odata/v2//https://api4preview./odata/v2//https://api5./odata/v2//https://api8./odata/v2//https://apisalesdemo8./odata/v2//https://api8preview./odata/v2//https://api10./odata/v2//https://api10preview./odata/v2//https://api012./odata/v2//https://apirot./odata/v2//https://api12preview./odata/v2//https://api15./odata/v2//https://api16./odata/v2//https://api17preview./odata/v2//https://api17./odata/v2//https://api18preview./odata/v2//https://api18./odata/v2//You can assign the created data model to a View and UI5 controls can be bound to it. Please refer documentation available at the below link for more information.//https://sapui5.hana./#docs/guide/96804e3315ff440aa0a50fd290805116.html#loio96804e3315ff440aa0a50fd290805116//The below code snippet for printing on the console is for testing/demonstration purpose only. This must not be done in real UI5 applications.oModel.attachRequestCompleted(function(oEvent){var oData = oEvent.getSource().oData;console.log(oData);});

在SAP云平台ABAP编程环境里消费API的ABAP代码：

TRY.
"create http destination by url; API endpoint for API sandbox 
DATA(lo_http_destination) = 
     cl_http_destination_provider=>create_by_url( 'https://sandbox.api./successfactors/odata/v2/User' ).
  "alternatively create HTTP destination via destination service
    "cl_http_destination_provider=>create_by_cloud_destination( i_name = '<...>'
     "                            i_service_instance_name = '<...>' )
    "SAP Help: https://help./viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/f871712b816943b0ab5e04b60799e518.html

"Available API Endpoints
"https://api2./odata/v2
"https://apisalesdemo2./odata/v2
"https://api2preview./odata/v2
"https://api4./odata/v2
"https://apisalesdemo4./odata/v2
"https://api4preview./odata/v2
"https://api5./odata/v2
"https://api8./odata/v2
"https://apisalesdemo8./odata/v2
"https://api8preview./odata/v2
"https://api10./odata/v2
"https://api10preview./odata/v2
"https://api012./odata/v2
"https://apirot./odata/v2
"https://api12preview./odata/v2
"https://api15./odata/v2
"https://api16./odata/v2
"https://api17preview./odata/v2
"https://api17./odata/v2
"https://api18preview./odata/v2
"https://api18./odata/v2

"create HTTP client by destination
DATA(lo_web_http_client) = cl_web_http_client_manager=>create_by_http_destination( lo_http_destination ) .

"adding headers with API Key for API Sandbox
DATA(lo_web_http_request) = lo_web_http_client->get_http_request( ).
lo_web_http_request->set_header_fields( VALUE #( 
(  name = 'Content-Type' value = 'application/json' )
(  name = 'Accept' value = 'application/json' )
(  name = 'APIKey' value = 'e9ZLBOfIplCOnibykWXsAfkMUexchhHN' )
 ) ).

"Available Security Schemes for productive API Endpoints
"Bearer and Basic Authentication
"lo_web_http_request->set_authorization_bearer( i_bearer = '<...>' ).
"lo_web_http_request->set_authorization_basic( i_username = '<...>' i_password = '<...>' ).

"set request method and execute request
DATA(lo_web_http_response) = lo_web_http_client->execute( if_web_http_client=>GET ).
DATA(lv_response) = lo_web_http_response->get_text( ).

CATCH cx_http_dest_provider_error cx_web_http_client_error cx_web_message_error.
    "error handling
ENDTRY.

"uncomment the following line for console output; prerequisite: code snippet is implementation of if_oo_adt_classrun~main
"out->write( |response:  { lv_response }| ).