Deal Usage API

1.0.x
(0 reviews)

Deal Usage API

The Deal Usage Report API allows users to search for deals, access detailed deal information, and retrieve related DSV, POS, Cisco Order, and claim line items tied to a specific deal Id.

Key Design Principles & Standards

This API is built following best practices and Cisco’s internal guidelines to ensure consistency, security, and usability:

RESTful Architecture

Adheres to Cisco REST Style Guidelines, including:

  • Clear usage of HTTP methods (GET, POST, etc.)
  • Resource-oriented URL paths
  • Standardized query parameters and response structures
  • Consistent use of JSON for request and response payloads
  • Semantic versioning

Security Compliance

Implements Cisco REST Security Recommendations:

  • Transport Layer Security (TLS)
  • Authentication and Authorization (AuthN/AuthZ)
  • Input validation and sanitization
  • Rate limiting and throttling

Pagination Support

Supports offset-based pagination using offset and limit query parameters.
Responses include pagination metadata and RFC 5988-compliant Link headers for seamless navigation:

  • next
  • prev

Reviews