DSV API

1.Introduction :

Cisco has prepared this document for implementing configuration solutions specific to DSV API. The DSV API Implementation Guide describes the functionalities and the data exchange mechanism to interact and integrate with Cisco to check availability / status / details of DSV Booking for a given Disti SO#. This document discusses various technical and functional aspects of web services, such as connectivity, message specifications, and test client programs.

1.1 Overview

The interactions between the partner systems and Cisco are done by a request and response JSON interchange mechanism. The DSV API is an on-demand service wherein a partner can choose to check availability / status / details of a DSV Booking for Disti SO# at any time during standalone order creation, change booking submission, etc.

1.2 Audience

The intended audience for this document is Business Analysts, IT Engineers, and Technical Architects who are involved in the integration project. Other stakeholders who wish to understand business and/or technical aspects of integration may also use the document as a reference

1.3 Scope

The scope of this document is limited to Cisco’s DSV API. It can be used to check availability / status / details of a booking transaction.

1.4 Pre-Requisites

• It is assumed that the reader has some familiarity with Cisco’s Distribution Finance platform through either formal or informal training and/or demonstration.

• The credentials to access DSV API must have been previously established. Please contact your Partner Solutions representative for assistance if they are yet to be established.

2. Process for Distribution Sales Visibility API

The Distribution Sales Visibility API has two End Point Resources getStatus and getDetails.

2.1 Status

• 1.The Status end point lets partners Check Booking status for a given Disti SO#.

• 2.In the response for service, the user will get the availability/ Status/ Details information of a booking transaction in WIPS system.

If the request processing is not successful, an error response is sent. The partner can then correct and resubmit the request.

The process for DSV API is as follows:

• The partner creates a JSON having Disti SO# and sends the request for Booking status check using the Status service.

• Based on the request, availability information is sent back that includes status, error messages, price, quantity, expiration date and so on.

Note: The web service request supports an array of Disti SO# to check the booking status and provides response of maximum 500 records . If number of records in the result set exceeds 500 for the request, web service allows partner / user to retrieve the next set of data using pagination feature.

2.2 Details

• The Details end point lets partners check detailed attributes of booking information for a given Disti SO#.

• In the response for service, the user will get Reseller, Bill To and other attributes of a booking transaction in WIPS.

If the request processing is not successful, an error response is sent.The partner can then correct and resubmit the request.

Note: The web service request supports only one Disti SO# to check the booking details and provides response of maximum 500 records . If number of records in the result set exceeds 500 for the request, web service allows partner / user to retrieve the next set of data using pagination feature.

These are suite of lightweight services only meant for checking availability / status / detailed attributes of DSV Booking transactions, it does not create/validate bookings.

2.3 Search DSV

• The SearchDSV endpoint enables partners to search for existing DSVs. This web service request supports all attributes available in the /status, /details APIs, and all other attributes accessible in the Bookings Search UI.

• The response from the service includes all attributes visible in the Bookings Search UI grid or Excel download, in addition to existing attributes from the /status and /details APIs.

• If the request processing encounters an error, an error response will be returned. Partners should review and correct the request before resubmitting.

Note: The web service request returns a maximum of 500 records. If the result set exceeds 500 records, partners can use the pagination feature to retrieve subsequent data sets.

These lightweight services are designed solely to verify the availability of status and detailed attributes of DSV Booking transactions and do not create or validate bookings.

3.Technical Specifications

This section contains the technical specifications for the DSV API suite of Web Services.
The Distribution Sales Visibility Bookings API is published via Mulesoft API Gateway.

3.1 Communication Protocol

Cisco supports the NextGen web services through Mule API Gateway. The document is sent over an https call.

3.2 Authentication

To access and interface with this API, partners need:

• A valid Cisco user ID (CCO ID)

• Registered application with Cisco’s MuleSoft Anypoint API portal

  Please refer the section "Access Request Steps" to request Access to this API.

  Please refer "Mocking Service Section": to try the API

3.3 END Points :

Prod

3.4 Bearer Token

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

Http Method: POST
x-www-form-urlencoded
- grant_type : client_credentials
- client_id : provide the client Id of registered application
- client_secret : provide the client Secret of registered application