Support API

User onboarding process

Overview

Cisco Support APIs are available only to Cisco Smart Net Total Care (SNTC) customers and Cisco Partner Support Service (PSS) partners. Access is gated through a role-based process administered via the Cisco Services Access Management tool.

API user account types

Specific registered Cisco.com user accounts (representing the application developer) are granted access to the Support APIs on behalf of a customer SNTC or partner PSS organization. These API users are then empowered to register unique application integration instances, generate API tokens, and start making API requests to retrieve Support APIs data.

An API user can be either:

  • A customer user - a developer who is a member of a customer's SNTC organization, previously onboarded via the customer's SNTC portal by the organization's Delegated Administrator (DA).

  • A partner user - a non-customer partner developer, whose Cisco.com ID is a member of a Cisco PSS partner organization. The partner organization must have at least one valid SNTC contract with the delegating customer's organization.

Customer onboarding steps

  1. Complete the instructions described in Cisco Smart Net Total Care Portal Onboarding Guide.

    Note: if this is an existing SNTC organization, completing all the steps may require approval from your organization's Delegated Administrator.

  2. The customer SNTC Delagated Administrator can then grant API access to an API user via the Cisco Services Access Management Tool.

    For details, see: Granting API access for customer users

Partner onboarding steps

  1. Go to the Cisco Partner Support Service Community page, and click the Request access to PSS APIs and the API Console link located in the Getting Started with PSS section.

  2. Enter the requested information in the email form.

    IMPORTANT! You must include a PSS contract number or your request cannot be processed.

  3. Once the Cisco Smart Service Bureau verifies your information, they will open a case with the Cisco Technical Assistance Center (TAC) case on your behalf. The Cisco TAC engineer will then grant you access to both the Smart (PSS) API and the Support APIs.

    Note: The onboarding process can take up to 48 hours after submitting the initial request.

Once the onboarding/access processes are complete, the API user can access the Cisco API Console to register an application with one-or-more of the Support APIs.

Next