cancel
Showing results for 
Search instead for 
Did you mean: 
cancel
412
Views
0
Helpful
4
Replies

Cisco Product Search by Keyword

wordenj
Level 1
Level 1

Is there a public API that would find Cisco part numbers or families based on keyword?

I know the bug tool has one built in that returns JSON, but it requires SSO authentication and is a backdoor API:

https://bst.cisco.com/api/productAutocomplete?productsearchTerm=vg224

{
  "autoPopulateHMPProductDetails": [
    {
      "parentMdfConceptId": 270675370,
      "parentMdfConceptName": "Cisco VG Series Gateways",
      "mdfConceptId": 278514984,
      "mdfConceptName": "Cisco VG224 Voice Gateway",
      "mdfMetaclass": "Model"
    }
  ]
} 

 

2 Accepted Solutions

Accepted Solutions

The support API documentation for Products is at https://developer.cisco.com/docs/support-apis/product-information/
There is no option to pass in a search parameter.

View solution in original post

For finding Product IDs, you can search for data sheets on Cisco.com. The Data Sheets almost always contain the Product IDs. Also if you have one of the products, you can use the search by serial number. If your company has purchased a service contract from Cisco, you can create a free account on CX Cloud (https://cx.cisco.com/activate) and connect your devices so you have all your asset information at your fingertips, including the Product ID.

View solution in original post

4 Replies 4

wordenj
Level 1
Level 1

For more context the official API would return the following:

GET https://apix.cisco.com/product/v1/information/product_ids/vg224

{
    "pagination_response_record": {
        "last_index": 1,
        "page_index": 1,
        "page_records": 1,
        "self_link": "https://apix.cisco.com/product/v1/information/product_ids/vg224?page_index=1",
        "title": "Product Info API - Get Product Information by Product Id(s)",
        "total_records": 1
    },
    "product_list": [
        {
            "id": "1",
            "product_id": "vg224",
            "product_name": "",
            "product_type": "",
            "product_series": "",
            "product_category": "",
            "product_subcategory": "",
            "release_date": "",
            "orderable_status": "",
            "dimensions": {
                "dimensions_format": "",
                "dimensions_value": ""
            },
            "weight": "",
            "form_factor": "",
            "product_support_page": "",
            "visio_stencil_url": "",
            "rich_media_urls": {
                "small_image_url": "",
                "large_image_url": ""
            },
            "ErrorResponse": {
                "APIError": {
                    "ErrorCode": "NO_RECORDS_FOUND",
                    "ErrorDescription": "No records found with the specified product id",
                    "SuggestedAction": "Please check given product id"
                }
            }
        }
    ]
}



 

The support API documentation for Products is at https://developer.cisco.com/docs/support-apis/product-information/
There is no option to pass in a search parameter.

Is there somewhere I could suggest adding a new endpoint to this API that allows a search? Or vote on an existing request?

It's difficult to provide the correct product_ids when there no source to find them. It's more of a trial and error approach. Also the product_ids needs to be exact, so you can't even use a wildcard or truncate them.

For finding Product IDs, you can search for data sheets on Cisco.com. The Data Sheets almost always contain the Product IDs. Also if you have one of the products, you can use the search by serial number. If your company has purchased a service contract from Cisco, you can create a free account on CX Cloud (https://cx.cisco.com/activate) and connect your devices so you have all your asset information at your fingertips, including the Product ID.