B2B-GRAPHQL-UAT-API
home
Elevate your business with the Commerce Modern API—your single, powerful gateway for managing Cisco catalogs, quotes, orders, subscriptions, invoices, and much much more . Built on a robust GraphQL foundation, our API empowers partners to access, create, and monitor every aspect of commerce operations in near real time. Experience faster integrations, smarter workflows, and unparalleled flexibility to drive growth and deliver exceptional customer experiences.
This document provides essential information for establishing basic connectivity to Cisco Commerce Modern APIs.
1. Prerequisites & Access:
Target Audience:
Cisco channel partners with an Internet Commerce Agreement (ICA) and capabilities for Cisco Commerce Workspace (CCW) lookups/transactions.
API Administrator:
Identify a Lead Developer/Architect to be nominated as an Administrator for Cisco Commerce APIs (CCW Graph API). This person will register on Cisco's login page and request CCW Graph API access via the CISCO IT Developer Portal located at https://it-developer.cisco.com/.
2. Security & Network Configuration:
Firewall Rules:
Your organization's firewall must allow access to the following hosts (any context path):
Non-Production (Test):
capitest.cisco.com
Production:
capi.cisco.com
id.cisco.com
Connectivity Check: Verify connectivity by pinging the above hosts (e.g., ping capi.cisco.com).
OAuth 2.0: APIs are secured by OAuth 2.0.
Proxy Configuration: Tunneling through a proxy server is beyond the scope of this document. Consult your Network Administrator for proxy configuration and usage.
3. API Environments:
Cisco provides distinct environments for development, testing, and production. All environments use the same authentication/token generation URL: https://id.cisco.com/oauth2/default/v1/token
User / Business Acceptance Test (UAT/BAT):
Purpose: Latest capabilities under development, shared with strategic partners for co-design/testing.
Stability: Constant state of flux, perceived as unstable, no uptime guarantee.
API URL: https://capitest.cisco.com/commerce/UAT/apis
Partner Onboarding Environment (POE):
Purpose: Quarterly refreshed from production, maintains sync with production.
API URL: https://capitest.cisco.com/commerce/POE/apis
Production:
Purpose: Real-life production transactions.
API URL: https://capi.cisco.com/commerce/apis
4. Application Registration (CISCO IT Developer):
Register your application in the CISCO IT Developer Portal. It is highly recommended to use two instances:
One for development/test (e.g., ABC-OfferTracker-Test with CCW Graph API UAT & POE).
One for production (e.g., ABC-OfferTracker with CCW Graph API).