dfm-rivt-internal-api-poe

1.Introduction :

This document has been prepared by Cisco to provide detailed information on the RIVT Internal API(s). The API(s), getRanStn, getRanStnCr and validateReseller are designed to validate the reseller and retrieve partner details mapped to specific BEGOID information and site details respectively. These APIs offer flexible querying options, without requiring mandatory input parameters in the request body. This allows customers to fetch data based on various combinations of input criteria, tailoring the responses to their specific needs.

1.1 Overview

The RIVT Internal API(s) are designed for on-demand use, enabling users to dynamically validate resellers using key input parameters such as resellerAccNo, service, and customerNumber.

The APIs, getRanStn and getRanStnCr, are currently integrated with the DMP application, allowing for data retrieval based on parameters like begeoId, sourceProfileId, distiTheatre, resellerAccountNumber, partnerSoldToName, and partnerSiteId. These API(s) provide filtered and accurate results, precisely tailored to the user's query.

All responses are delivered in a structured JSON format, complete with pagination for efficient data management. This ensures ease of use and seamless integration into various applications, supporting both performance and scalability.

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 RIVT Internal API(s). It can be used to validate the reseller and retrieve partner details mapped to fields such as BEGOID, sourceProfileID, distiTheatre, resellerAccountNumber, partnerSoldToName and partnerSiteId.

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.
• To access the RIVT Internal APIs, users must submit an access request to obtain a client ID and client secret, which are required to generate the bearer token, it is necessary for API calls.
Detailed instructions for submitting an access request can be found in the "Access Request Steps" section.

2. Process for RIVT Internal API

The RIVT Internal API has three end point resources getRanStn , getRanStnCr and validateReseller.

2.1 getRanStn

• 1.The getRanStn end point lets users check details of the partner.

• 2.In the response for service, the user will get the sourceProfileId, resellerAccountNumber, distiTheater, distiSourceName, soldToName, partnerBeGeoId & partnerBeGeoName information of a partner details.

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

Note: The web service request supports query params to check the 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 getRanStnCr

• 1.The getRanStnCr end point lets users check details of the partner.

• 2.In the response for service, the user will get the partnerSiteDetails along with sourceProfileId, resellerAccountNumber, distiTheater, distiSourceName, soldToName, partnerBeGeoId and partnerBeGeoName information of a partner details.

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

Note: The web service request supports query params to check the 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.3 validateReseller

• 1.The validateReseller end point lets users check validation of the partner.

• 2.In the response for service, the user will get the resellerName, registrationStatus, regEffectiveStartDate & registrationExpiryDate information of a partner details.

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

3.Technical Specifications

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

POE

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