The HCS APIs
HCS offers several groups of APIs that allow you to provision, monitor and integrate with a cloud deployment. Developers can also use the APIs offered by the Collaboration applications to extend the collaboration services offered in HCS.
Fulfillment
The Fulfillment APIs are a set of SOAP APIs that help you configure, service and control a Cisco HCM-F deployment. These APIs include:
- Shared Data Repository Web Service API - provides APIs to view and modify data in the Shared Data Repository.
- Fulfillment Web Service API - provides an interface to perform tasks such as triggering manual syncs, starting manual syncs, and restarting jobs.
- Service Inventory Web Service API - provides an interface for scheduling, configuring, and executing the generation of service inventory billing reports.
- HCS License Manager Web Service API - provides an interface for scheduling, configuring, and executing the generation of service inventory billing reports.
- Platform Administration - provides an interface for scheduling upgrades and backups.
- Automated Provisioning - a feature of the Fulfillment web service that supports automated provisioning of services
Assurance
HCS offers a single, normalized fault management interface from multi-component HCS SA system. Two types of interfaces are available to assist with monitoring of HCS deployments. Both interfaces offer configurable filtering capabilities to suit the needs of different northbound consumers.
- SNMP Trap Notifications - supports multiple SNMP gateway subscriptions. The maximum subscriptions allowed at one time is five. The gateway subscriptions support the ability to filter the incoming traps. A Python client script supports subscribe and unsubscribe calls into the Event Management NBI. In addition, MIB definition for SNMP notifications generated by the NBI is also supported.
- Prime Central for HCS Web Services API - provides an interface to subscribe/unSubscribe to events, and to retrieve and filter information about events.
Billing
HCS developers can use the call reporting features and interfaces that are built into Cisco Unified Communications Manager to create custom billing solutions and integrations.
- Cisco Unified CM Call Detail Records - supports CDR Analysis and Reporting which generates reports for Quality of Service (QoS), traffic, and billing information. Partners can use this information to create their own billing applications and processes.
Collaboration Application APIs
Developers can use the APIs provided the Collaboration Applications that are hosted in HCS to develop custom solutions and extend the collaboration services offered in HCS
Next Steps
