STEPS TO FOLLOW........................................................................................................................................ 3
This document describes how SAP partners can locate and use the Application Interface Key, which is required to call every SAP LoB API as part of the Application Interface Register (AIR). Each registered partner application has been issued a unique 8-character alphanumeric key called the Application Interface Key. Partners can build and deploy compliant applications by providing the Application Interface Key when calling SAP APIs.
Partners can access their Application Interface Key via:
• Manage My Partnership web portal • Manage My Apps (MMA) web portal • MMA mobile Interface
Partner building solutions that integrate or connect to SAP LoB Applications via APIs MUST include the Application Interface Key provided by SAP in the API Header as described below.
STEPS TO FOLLOW
1. Register your new app in the Manage My Apps portal by providing needed details. If you need assistance with the portal, please contact your Partner eXperience Manager (PXM).
2. Get the Application Interface Key for your application. As shown in the screenshot, copy the key from the application details page in Manage My Apps portal.
3. The actual key value to be sent depends on environment in which API call is made. The environment is determined by the SAP LoB Application environment (i.e. the API callee) and not the environment of the API caller.
SAP LoB Application Environment Value
Production <Application Interface Key from MMA> ICC Certification Process <Application Interface Key from MMA> Non-Production (Dev, Test, Demo, etc.) saptest0
NOTE: Use the Application Interface Key copied from Manage My App portal for your production environment only.
4. Add the following custom header while making a direct API call to any SAP system. This includes any HTTP-based API or OData service exposed by SAP LoB Applications.
5. [NOTE: This section is only applicable to partners that build and publish integration flows to customers. If you don’t use iFlows in your application, then please proceed to the next section.]
If you are using SAP Integration Suite and you have built/published your own custom integration flow (iFlow), please do the following steps to make your iFlow compliant with AIR:
a. Add a new Content Modifier to include the new AIR header. In the screenshot below, it’s called Add AIR Header.
b. In the Message Header section of the newly added content modifier, create a new header with name Application-Interface-Key and externalize the value, such that it is configurable by the customer.
c. During the provisioning time of the iFlow, you will have to provide the Application-Interface-Key to the customer so that it can be used for configuring the iFlow. Or, if you are configuring it for the customer, you can configure the Application-Interface-Key yourselves.
4 FREQUENTLY ASKED QUESTIONS
Question 1: What happens if I pass incorrect key or don’t pass it at all?
Partners are contractually obliged to pass the Application Interface Key while calling SAP API. The SAP operations team will monitor the usage of Application Interface Key and report missing usage.
Question 2: Will my existing app continue to work?
The existing apps will continue to work.
Question 3: The SAP LoB solution documentation doesn’t list this header, should I still pass it?
Yes, the Application-Interface-Key is to be sent with every API call even if it is not listed in the LoB solution page.
Question 4: Do I need to send the Key only from backend or from UI as well?
The key header must be sent from wherever the API call to SAP system is made, it can be both UI or backend.
Question 5: I have a Microservice architecture with multiple services calling SAP APIs. Should I send this key header in all such calls?
Yes, the key header should be included every time.
Question 6: Do I need to pass the key when using SAP Integration Suite?
Yes, the key header should be included when making calls from SAP Integration Suite or from any other 3rd party middleware.
Question 7: Do I need to pass the key if my application is on public clouds like AWS, GCP etc.
5 Yes, the key header should be included in all applications irrespective of which platform they are running on. A Partner application running on any infrastructure (SCP/Non-SCP) needs to mandatorily include the key header.
Question 8: Do I need to implement the AIR key for new deployments only or for existing customers as well?
The AIR key is associated with a particular application. So, you should incorporate the AIR key with the next version of your application and subsequently roll it out to all customers.
Question 9: What types of API invocations require the AIR key?
The AIR key is required for all HTTP-based APIs and OData services exposed by SAP LoB applications (both on-premise and cloud). However, SOAP service calls do not need to include the AIR key at the moment.
Question 10: Is the AIR required for SAP LoB applications both on-premise and on the cloud?
Yes, the AIR key is required for SAP LoB applications both on-premise and on the cloud. Partner applications do not need to concern themselves about making the decision whether the SAP LoB application is running on- premise or on the cloud.
Question 11: Who should I contact if I have any additional questions?
Please contact your Partner eXperience Manager (PXM), your partner business manager (PBM), or your SAP representative.
No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP SE or an SAP affiliate company.
The information contained herein may be changed without prior notice. Some software products marketed by SAP SE and its distributors contain proprietary software components of other software vendors. National product specifications may vary.
These materials are provided by SAP SE or an SAP affiliate company for informational purposes only, without representation or warranty of any kind, and SAP or its affiliated companies shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP or SAP affiliate company products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.
In particular, SAP SE or its affiliated companies have no obligation to pursue any course of business outlined in this document or any related presentation, or to develop or release any functionality mentioned therein. This document, or any related presentation, and SAP SE’s or its affiliated companies’ strategy and possible future developments, products, and/or platform directions and functionality are all subject to change and may be changed by SAP SE or its affiliated companies at any time for any reason without notice. The information in this document is not a commitment, promise, or legal obligation to deliver any material, code, or functionality. All forward-looking statements are subject to various risks and uncertainties that could cause actual results to differ materially from expectations. Readers are cautioned not to place undue reliance on these forward-looking statements, and they should not be relied upon in making purchasing decisions.
SAP and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP SE (or an SAP affiliate company) in Germany and other countries. All other product and service names mentioned are the trademarks of their respective companies. See www.sap.com/copyright for additional trademark information and notices.
