5.4: CcaAPI & CcaWebAPI installation

5.4: CcaAPI & CcaWebAPI installation

Summary Installation guide for ccaAPI and ccaWebAPI
Applies to askiafield
Written for system administrators
Keywords installation ; CCA ; CcaAPI ; CcaWebAPI ; Web service

5.4 brings the usage of askiafield API. Once installed you can act with your Cca through JSON requests.

To take the full advantage of this, you need to install two Web Services on a web server:

  • CcaAPI: that's the link between the web server and the Cca server.
  • CcaWebAPI: that's the web service used for sending JSON requests.

These installers are available in any 5.4 folders on and are pretty straightforward to use. Here the seteps to follow:


1/ Install CcaAPI first:



 There is a check of some requirements made at the beginning of the installation. 



You need to select the website where you want to install the ccaAPI. It will create a new application named "CcaAPI"


Then it will create a web application pool (CcaAPIappPool):


At this stage, you need to enter the internal IP address of your Cca server (the communication is made through the port TCP 980).


Then enter the extern IP for this Cca server.


Thats all. The ccaAPI is installed. You can validate it by checking "Open CCA API" on the last screen of the setup:

That will open this link into your default browser:




2/ Then, you're ready to proceed to the installation of CcaWebAPI: 


The 4 first screens of the installer are identical to the ccaAPI setup:


On this screen, you will need to enter the link to the CcaAPI with the external IP Address / DNS of the server where its installed:


Once again, you can validate the installation by checking "Open CcaWebAPI" on the final page of the setup:


 The link http://[ServerName]/CcaWebApi will be open into your default browser. That's the documentation page for all possible commands usable to communicate with Cca:


Just click on the action you want to perfrom, and it will expand a window with all commands and parameters to use:




Once installed, you can check them into your IIS manager.


In Application pools:

and at the root of the website where you installed them:












Have more questions? Submit a request