Introduction

• Cisco API Gateway Proxy Overview, page 1

• Authentication and Authorization, page 2

• Synchronous and Asynchronous Operations, page 3

Cisco API Gateway Proxy OverviewThe API Gateway Proxy provides a single point of integration for Partner OSS integration to APIs forprovisioning DomainManagers and other Cisco Hosted CollaborationMediation Fulfillment utilities includingService Inventory, Shared Data Repository and Cisco Hosted Collaboration Mediation Fulfillment LicenceManager. The API Gateway Proxy uses a routing proxy that is based on customer information stored in theShared Data Repository.

The API Gateway Proxy leverages infrastructure information in the Shared Data Repository to route APIrequests to the appropriate application.

Cisco Hosted Collaboration Mediation Fulfillment provides a repository for Cisco HCS-related applicationinfrastructure information through the Shared Data Repository for:

• Customers

• Clusters

• Application Instances (i.e. application servers)

• Network Addresses

• Credentials

The API Gateway Proxy supports UC 10.x applications, however the API support is limited to UC 9.xAPIs. This provides for continuedAPI Gateway Proxy support of 9.x capabilities with UC 10.x applications.

Note

The following figure outlines the architecture of the API Gateway Proxy solution.

• All purple nodes (domainmanagers and Unified Communications applications) represent the applicationsthat the API Gateway Proxy can route to.

Cisco Hosted Collaboration Mediation Fulfillment API Gateway Proxy Developer Guide, Release 10.6(1) 1

All green nodes represent the Cisco Hosted Collaboration Mediation Fulfillment nodes.

Figure 1: Cisco HCS API Gateway Proxy Architecture

The API Gateway Proxy runs on port 8443. This port needs to be accessible to client applications. Referto Application Reference Directory for more information on URLs.

Note

Authentication and AuthorizationOnly Cisco Hosted Collaboration Mediation Fulfillment administrative users are authorized to use the APIGateway Proxy. Any API requests that come into the API Gateway Proxy must carry the administrationcredentials of the Cisco Hosted Collaboration Mediation Fulfillment system.

Different applications use different types of authentication:HTTP orHTTPS

AuthenticationDefinitionMessageExchange Pattern

WebServiceType

ApplicationService

HTTPSBasicAuthentication

WSDLSynchronousSOAPHCM-FSharedDataRepository

HTTPSBasicAuthentication

WSDLSynchronousSOAPHCM-FHCSLicenseManager

Cisco Hosted Collaboration Mediation Fulfillment API Gateway Proxy Developer Guide, Release 10.6(1)2

IntroductionAuthentication and Authorization

HTTP orHTTPS

AuthenticationDefinitionMessageExchange Pattern

WebServiceType

ApplicationService

HTTPSBasicAuthentication

WSDLSynchronousSOAPHCM-FFulfillment

HTTPSBasicAuthentication

WSDLSynchronousSOAPHCM-FServiceInventory

HTTPSWS-SecurityWSDLSynchronousSOAPCCDMResourceManagement

HTTPSBasicAuthentication

InterfaceGuide (NoWADL)

SynchronousRESTCCDMResourceManagement

HTTPSWS-SecurityWSDLSynchronousSOAPCCDMSubscriptionManager

HTTPSWS-SecurityWSDLAsynchronousSOAPCCDMNotificationManager

HTTPSWS-SecurityWSDLSynchronousSOAPCUCDMucFulfillment

HTTPSNotApplicableWSDLAsynchronousSOAPCUCDMasyncNotification

HTTPNot applicableWSDL1AsynchronousSOAPCCDMNotifications

HTTPSBasicAuthentication

WSDLSynchronousSOAPCUCMAXLAPIService

HTTPSBasicAuthentication

WSDLSynchronousRESTCUCXNVMRest

HTTPSBasicAuthentication

WSDLSynchronousSOAPCUCXNMessageEventService

HTTPSBasicAuthentication

WSDLSynchronousSOAPCUPClientConfiguration

1 An example wsdl specification for CCDM notifications can be found in the Unified CCDMWeb Services Reference document.

Based on the credentials that are configured within the SDR, the API Gateway Proxy uses the appropriatecredentials for each application. This process is covered in more detail in the Shared Data RepositoryInfrastructure Configuration.

Synchronous and Asynchronous OperationsMost operations or API functions through the API Gateway Proxy are synchronous. This means that everyrequest yields a response as soon as the API has completed.

The API Gateway Proxy also supports asynchronous notifications. Asynchronous notifications are associatedto an original request, but the main difference is that there can be numerous asynchronous notifications, andthey can come in at different times after the request. Some technology-independent examples are:

1 An asynchronous notification is sent after a background task on the server is completed.

2 An asynchronous notification is sent every time a remote resource is modified on the server.

Cisco Hosted Collaboration Mediation Fulfillment API Gateway Proxy Developer Guide, Release 10.6(1) 3

IntroductionSynchronous and Asynchronous Operations

The Cisco Unified Contact Center Domain Manager supports asynchronous notifications, but with explicitsubscriptions.

The API Gateway Proxy will insert itself into the route of these notifications. It does this by overwritingthe client's notify-to address with its own. Apart from that difference, asynchronous notifications workseamlessly through the API Gateway Proxy. Refer to the section Global Address and Port Configurationto understand how that configuration changes the information that appears in the notify-to header.

Note

For more information about the synchronous and asynchronous behavior of the APIs, refer to theapplication-specific documentation.

Cisco Hosted Collaboration Mediation Fulfillment API Gateway Proxy Developer Guide, Release 10.6(1)4

IntroductionSynchronous and Asynchronous Operations