Testing the implementation of Application Interface Register Key
This blog covers testing the implementation of the Application Interface Register(AIR) Key provided to partner solutions that integrate with SAP on-prem solutions( SAP ECC, SAP S/4HANA, SAP BW/4HANA, etc) as well as SAP S/4HANA Cloud, private edition. The partner/ISV solutions that integrate with SAP solutions via HTTP-based APIs (SOAP and REST) or OData services exposed by SAP applications are required to implement AIR Key. The below approach can be used as an alternative to using tools like HTTP Watch.
- SOAP Webservices using HTTP.
Note: The example shown below uses a WSDL file for the Webservice created using RFC. This WSDL file was imported into SoapUI for testing AIR Key included in the header. The WSDLs for the configured Webservice are imported in the partner application to call the RFC in the SAP system. The steps of creating and importing WSDLs are not a part of this document.
a. Validating webservice for AIR Key
Run Txn -> SOAMANAGER in SAP system. If the host file is configured correctly, the below page should load after signing in.
b. Select Logs and Traces à SOA Runtime Traces
c. Use default values in all the fields. Choose Consumer/Provider or both for the type of Webservice. Save Configuration. Go to the Functional Trace tab.
d. Web-Service Execution.
Execute the call from the application. It is expected that partner application calls to SAP will have the AIR key in the HTTP header.
Below SoapUI tool is used to call a webservice with AIR-Key “abcd1234” in the header.
Send request to SAP system.
After configuring the SAP SOAP webservice WSDL into the partner application, the http requests to SAP can be sent together with assigned AIR Key. This AIR key is sent as a value to a new custom HTTP Header “Application-Interface-Key”.
Response from SAP system is received.
e. Go back to screen at step c, refresh. Select entry, choose display
f. Select “Request” Choose “Display Trace Data” àClick “Display HTTP Header”
g. Locate AIR-Key in HTTP header info.
- Gateway OData Service
a. Find GW service run txn /n/IWFND/MAINT_SERVICE. Locate and click on the service. Click either “Call Browser” or “SAP Gateway Client”. Browser call requires host file configuration.
b. Request URI looks something like below. This is what is called by the partner application.
c. To set up API Key tracing, run txn /n/IWFND/TRACES à Check “Payload Trace” à Choose Payload Trace tab
d. Next is the test of OData API for the GET method. Partner application calls the Request URI(step b) from their application where AIR key is sent in the header of the request. In this example, SoapUI tool is used to call the GET method for checking SalesOrder. API key used is abcd1234
e. To check AIR key in SAP traces, go back to the screen in step C. Refresh. Select the entry and click display.
f. Select the GET Request and Choose “Display HTTP Header” to locate the AIR key.
AIR Key sent to SAP as header data of the API calls are traceable in the SAP system used during certification testing. AIR key is temporarily persisted in the SAP system within the traces/logs. If traces expire, so will the AIR key information. These steps can be performed internally for validation , before submitting for the certification solution demo.