About the Supplier Data API with Pagination

The Supplier Data API with Pagination allows you to get data about your suppliers, including their registration, qualification, and preferred status and details about their questionnaires and certificates, using pagination to limit the amount of data you get with each post. It also allows you to set questionnaire answers and qualification or preferred status.

It's only available for suppliers maintained in the following solutions:

  • SAP Ariba Supplier Lifecycle and Performance

  • SAP Ariba Supplier Information and Performance Management (new architecture)

  • SAP Ariba Supplier Risk

You can only retrieve and update data related to the functionality to which you're entitled as part of your solution package. For example, registration projects are only available in SAP Ariba Supplier Lifecycle and Performance and SAP Ariba Supplier Information and Performance Management (new architecture). Qualification, preferred supplier management, and process projects are only available in SAP Ariba Supplier Lifecycle and Performance.

The Supplier Data API with Pagination includes:

  • Pagination of returned results for all API endpoints, with specific limits on the number of results per page returned based on query parameters.

  • Filter parameters that allow you to post incremental requests for data.

  • Endpoints for getting supplier data, including IDs and registration, qualification, or preferred category status, and for setting qualification and preferred category status.

  • Multiple endpoints for fetching questionnaire data in different ways: for each supplier, you can get data for all questionnaires, all questionnaires for a specific project (workspace), or a specific questionnaire.

  • Multiple endpoints for fetching data about specific question answers within questionnaires: for each supplier, you can get answer data for all questions, questions from a specific project (workspace), or questions from a specific questionnaire.

  • An endpoint for fetching header-level data for all of a supplier's certificates.

  • An endpoint for setting questionnaire data in registration, qualification, and modular supplier management questionnaires.

  • Multiple endpoints for managing process projects from an internal system.

You can also create an application that uses the vendor data, certificate, and question and answer endpoints from this API, in combination with the External Approval API for Sourcing and Supplier Management endpoints for:

  • Retrieving questionnaire details and attachments, to not only retrieve certificate information but download certificate attachments collected in supplier management questionnaires.

  • Enabling external approval and status decisions for process projects and their modular questionnaires.

Prerequisites

Before you can use the Supplier Data API with Pagination, you must:

  • Complete the onboarding process on the SAP Ariba Developer Portal.

  • Ensure that your application conforms to expected OAuth authentication. Only applications approved by the SAP Ariba APIs administration can execute OAuth authentication.

Retrieving supplier certificate attachments and approving modular questionnaires used in process projects requires use of endpoints from the External Approval API for Sourcing and Supplier Management. You must complete prerequisites for use of that API separately, and use of that API requires a separate application key.

Security and Authentication

Prior to developing an application using the Supplier Data API with Pagination, you must register on the developer portal and obtain an application key, an OAuth client ID, and an OAuth client secret.

  • You must have Customer Support enable API access to your site.

  • Each API invocation retrieves data for a single site.

  • OAuth tokens are short-lived and expire 24 minutes (1440 seconds) after they're issued. Tokens must be refreshed.

Fields in Supplier Data API with Pagination Results

Endpoint results for the Supplier Data API can include some fields that are general across supplier management functionality and projects, and that aren't listed in the API swagger documentation on the SAP Ariba Developer Portal. Make sure that your API client applications only use and handle the fields that are listed in the API swagger documentation.