Deal Usage API

1. Introduction :

This document provides implementation guidelines for Cisco’s Deal Usage Report API, detailing its functionality, integration workflow, and data exchange mechanisms. It is intended to support seamless integration with Cisco systems to retrieve deal usage details for a given dealId.

The guide covers both technical and functional aspects of the API, including connectivity, request/response specifications, and test client guidelines.

1.1 Overview

The Deal Usage Report API uses a RESTful JSON request-response model to facilitate communication between partner systems and Cisco. This on-demand API allows partners to query deal usage data at any point in their process, such as during standalone order creation or change booking submissions.

1.2 Audience

This document is intended for:

• Business Analysts
• IT Engineers
• Technical Architects

Other stakeholders seeking to understand the technical or business aspects of the integration may also use this document as a reference.

1.3 Scope

This guide is specifically focused on Cisco’s Deal Usage Report API. It enables querying of deal usage details based on a provided dealId.

1.4 Pre-Requisites

Before proceeding, ensure the following:

• The reader is familiar with Cisco’s Distribution Finance platform, either through formal training or product demonstrations.
• Credentials and access rights to use the Deal Usage Report API have been provisioned. If not, contact your Partner Solutions representative for assistance.

2. Deal Usage API Endpoints

The Deal Usage API provides the following endpoints:

• GET /deals
• GET /deals/{dealId}/details
• GET /deals/{dealId}/transaction-lines

2.1 GET /deals

• Retrieves a paginated list of deal headers based on search criteria.
• Required Query Parameters:You must supply either a dealId or at least one of the following date range filters:
  • dealApprovalDateFrom / dealApprovalDateTo
  • dealExpirationDateFrom / dealExpirationDateTo
• Pagination:Uses offset and max query parameters.Pagination metadata is included in the response body, and RFC 5988-compliant Link headers (e.g., prev, next) are provided for navigation.

2.2 GET /deals/{dealId}/details

• Returns deal header information and a paginated list of Deal Detail Lines for the specified dealId.
• Supports offset and max query parameters for pagination.
• Includes Link headers (prev, next) for navigating through result pages.

2.3 GET /deals/{dealId}/transaction-lines

• Retrieves a paginated list of transaction lines associated with the given dealId.
• The type query parameter filters line items by category:
  • Valid values: dsv, pos, cisco-order, claim
• Pagination and Link header support follows the same pattern as other endpoints.

3. Technical Specifications

This section outlines the technical integration details for the Deal Usage Report API suite.

3.1 Communication Protocol

The API is hosted on Cisco’s MuleSoft API Gateway and supports secure HTTPS-based REST communication.

3.2 Authentication

To access the API, you must have:

• A valid Cisco CCO (Cisco Connection Online) ID
• A registered application in Cisco’s MuleSoft Anypoint API portal

🔒 Authorization Note:
Ensure that the CCO ID used to request API access is mapped to at least one source profile in the DSV application.
This mapping is required to receive appropriate and authorized deal data in the API response.

📌 For more information:

• Refer to the "Access Request Steps" section to initiate API access.
• Use the "Mocking Service" section to try out the API with test payloads.

3.3 END Points :

Non-Prod

3.4 Bearer Token

Non-Prod Token URL:
https://int-id.cisco.com/oauth2/default/v1/token

HTTP Method: POST
Content Type: x-www-form-urlencoded

Form Parameters:

• grant_type : client_credentials
• client_id : provide the client ID of registered application
• client_secret : provide the client secret of registered application