Distributor Inventory Submission API

1.Introduction :

Cisco has prepared this document for implementing configuration solutions specific to Inventory API. The Inventory API implementation Guide describes the functionalities and the data exchange mechanism to interact and integrate with Cisco to check status and submit inventory. 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 Inventory API is an on-demand service wherein a partner can choose to submit the inventory data and also to check the submission status at any time.

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 Inventory API. It can be used to check status / submit.

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 Inventory API must have been previously established. Please contact your Partner Solutions representative for assistance if they are yet to be established.

2. Process for Inventory API

The Inventory API has two End Point Resources getStatus and submitInv

2.1 getStatus

• 1.The getStatus end point lets partners check status of a submitted inventory data.

• 2.In the response for service, the user will get the batch & line status information of a submitted inventory to WIPS system.

If the request processing is not successful, an error response is sent. The partner should correct the invalid lines and resubmit both valid and invalid lines (or) exclude the invalid lines and resubmit the valid lines only.

Note: The web service request supports query params to check the status and provides response of maximum 1000 records . If number of records in the result set exceeds 1000 for the request, web service allows partner / user to retrieve the next set of data using pagination feature.

2.2 submitInv

• The submitInv end point lets partners to submit the inventory request for a source name.

• The partner creates a JSON having headers and lines and sends the request to this API.

• In the response for service, the user will get requestId, acknowledgement of the submission and pagination link to check the status of the submitted inventory data.

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 header as object and array to submit lines.

These are suite of lightweight services only meant for checking status / submit attributes of the distributor inventory data.

3.Technical Specifications

This section contains the technical specifications for the Inventory API suite of Web Services.
The Inventory 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

Token URL : https://id.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