How Do I Use QAPI?
Like most APIs, QAPI provides an endpoint and client credentials.
This enable developers to build custom integrations, authenticate requests, and exchange data with your systems or other external applications.
QAPI uses XML format for messages sent to and from the API.
QAPI requires configuration before use: see How Do I Get QAPI? for more details.
QAPI Functions
QAPI provides two functions:
1. Conversion Group Parameter Request
This function provides details of the parameters needed to perform calculations with a conversion group.
This is called when initially implementing QAPI, and at any time a conversion group is modified in your BCP or BCG configuration.
NOTE: BCS provides an ABAP tool allowing the generation of example calculation XML for a conversion group, to compliment the Conversion Group Parameter Request QAPI function (see Documentation below).
2. Calculation
This function allows you to perform bulk quantity calculations with a particular conversion group.
Batch calculations are supported.
Calculation parameters are sent by the calling system to QAPI, and the results of the calculation(s) performed by BCS are returned by QAPI.
Documentation
See the following documentation for detailed instructions:
This document describes the interaction with the QAPI functions, providing comprehensive information regarding the data that should be sent, how it should be sent, and how to process returned data, with example XML. (73 pages)
This document explains how to use the “Explain by Scenario” program, which allows you to generate the XML required to be sent to QAPI to match the settings of a specific test scenario, for use by an external party developing a solution with QAPI. (11 pages)
Categories: QAPI FAQs
Back to FAQs
