Version 3 by Nata Ramanenka
on May 07, 2012 06:01.
<< Changes from 2 to 3
compared with
Current by Shannon George
on May 07, 2012 12:15.
Key
This line was removed.
This word was removed. This word was added.
This line was added.

Changes (9)

View Page History
You can access the API Documentation by following the next below steps.

1. Open a Wweb browser and type in one of the following addresses: {{https://<cdpserveraddress>/apidoc}} or {{http://<cdpserveraddress>/apidoc}}.
{info:title=Note}You can configure the HTTP and SSL connections for API in the Configuration. There "Configuration." There, you can enable/disable HTTP and SSL connections, and specify ports and maximum allowed connections. For an SSL connection, you can define the keystore path. See [Configuring API Server Options].
{info}
!api-doc.png!

You can find instructions on how to find out the <cdpserveraddress> in [Accessing Enterprise Edition Web Interface].

2. Once you have established a connection to the CDP Server, you will see the main page of the R1Soft CDP Server API Documentation.
...
!api1.png!

3. To find the Class list of "Class List" in the API Documentation, click on "Classes" in the Main Menu.

!api2.png!

4. In the submenu, sub-menu of "Classes," you can access the following sections:
* *Class List (opens by default)*&nbsp;\- Shows the classes, structs, unions, and interfaces with brief descriptions.
* *Class Index* \- Provides Lists the Cclasses in alphabetical order.
* *Class Hierarchy* \- Shows the inheritance list of Cclasses in alphabetical order.
* *Class Members* \- The list of Lists all documented class members with links to the class documentation for each member.

!api3.png!
...