› KCM API Guide › KCM API overview › SOAP web services

SOAP web services

There are several groups of web services called contract types, some of which have multiple versions.

Currently, Kofax Communications Manager supports the following contract types:

  1. CCMInteractive, versions V1, V2, and V3
  2. CCMDistribution, versions V1 and V2
  3. CCMAdministration, version V1
  4. CCMContentApprovalWorkflow, version V1
  5. CCMCompatibility, version V1

Also, CCMCapabilities is available as a service.

To learn how to use the available calls and the CCMCapabilities service, see the chapter KCM API description.

The contract types are exposed as SOAP web services. You can obtain their respective WSDLs through the following URLs:

  1. CCMInteractive 
    http(s)://<kcm server>:<port>/ccm/wsdl?contracttypename=CCMInteractive&contracttypeversion=V1
    http(s)://<kcm server>:<port>/ccm/wsdl?contracttypename=CCMInteractive&contracttypeversion=V2
    http(s)://<kcm server>:<port>/ccm/wsdl?contracttypename=CCMInteractive&contracttypeversion=V3
  2. CCMDistribution 
    http(s)://<kcm server>:<port>/ccm/wsdl?contracttypename=CCMDistribution&contracttypeversion=V1
    http(s)://<kcm server>:<port>/ccm/wsdl?contracttypename=CCMDistribution&contracttypeversion=V2
  3. CCMAdministration 
    http(s)://<kcm server>:<port>/ccm/wsdl?contracttypename=CCMAdministration&contracttypeversion=V1
  4. CCMContentApprovalWorkflow 
    
http(s):<kcm server>:<port>/ccm/wsdl?contracttypename=CCMContentApprovalWorkflow&contracttypeversion=V1
  5. CCMCompatibility 
    http(s)://<kcm server>:<port>/ccm/wsdl?contracttypename=CCMCompatibility&contracttypeversion=V1
  6. CCMCapabilities 
    http(s)://<kcm server>:<port>/ccm/Capabilities

Each contract type version provides a consistent and complete set of calls. The calls within a contract type also have a version associated to them. This version is changed whenever the interface or behavior of a particular call is changed. This version is essentially global for that call and unrelated to the version of the contract types that the call is contained in.

The WSDL contains explicit anchors (^ and $) added to the pattern definitions.