View Source

h2. Accessing API Documentation

You can access the API Documentation by following the next steps.

1. Open a Web browser and type the following address: {color:blue}https://<cdpserveraddress>/apidoc{color} {color:black}or{color} {color:blue}http://<cdpserveraddress>/apidoc{color}

!api-doc.png!

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

!api-docs.png!

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

!classes.png!&nbsp;

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

!sub-menu.png!
{info:title=Note}You can use the Search window to find the necessary class in the API Documentation.
!search.png!
{info}
\\ {excerpt:hidden=true}Instructions on how to access the R1Soft API Documentation of CDP 3.0.{excerpt}
\\
\\