Reseller Identification and Validation API POE

(0 reviews)

Implementation

1.Introduction :

This document provides guidance for configuring the Reseller Identification and Validation API.

Connectivity: Details on how to establish and maintain connections with the API.

Message Specifications: Definition of the specific message formats and protocols used in communication.

Test Client Programs: Guidance on available testing tools and client programs for development and validation.

By following the guidance within this document, distributors can ensure a smooth and efficient integration with Cisco's Reseller Identification and Validation services.

1.1 Overview

The API Implementation Guide focuses on enabling distributors to seamlessly interact and integrate with Cisco. It covers functionalities that allow for searching, managing reseller mapping information, and downloading lists of global denied and verification-required resellers.

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 Reseller Identification and Validation API. It can be used for searching, managing reseller mapping information.

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

2. Reseller Identification and Validation API End Points

The Reseller Identification and Validation API has five End Point Resources

searchReseller
gdvrResellers
addRseller
updateReseller
deleteReseller
getSourceNames

2.1 Search Reseller

The Search Reseller endpoint allows you to search for an existing distributor to Cisco's 2T partner mapping information. Clients can filter results using various attributes provided in the request body, and the results are returned in a paginated format.This endpoint facilitates the discovery of specific resellers by offering customizable search functionality. By providing different attributes in the request body, users can narrow down the search results to meet their specific criteria. The response is paginated to offer an organized and manageable view, allowing for a minimum of 500 and a maximum of 1000 records per page.

This service returns a response based on the source profile mapped to the CCO ID used to request access to the API. The CCO ID must be mapped to at least one source profile. Once mapped, the service retrieves the master source profile for the CCO ID and provides results for all theaters and source profiles under that master source profile.

Parameters:

theaterCode: (string, required) An input parameter that is mandatory for this service.
Other parameters: (optional) Additional parameters may be included in the request, as needed.

Refer to the sections "Request Attributes" and "Response Attributes" for more detailed information on request, response attributes, formats and examples.

Pagination:

The response is paginated, and the response header includes links to the previous and next pages for the given input request body. This ensures easy navigation through large sets of data.

Note: Ensure that the CCO ID used for requesting access to the API is mapped to at least one source profile in DCA Application to receive the appropriate response. Please reach out to appropriate theater support mailer to have the source profile mapped to the CCO ID .