Installing the API

This topic covers how to get the ServiceCEO API Shot for Application Programming Interface. The ServiceCEO API is designed so that developers can extend ServiceCEO's functionality by writing their own programs (or web services) that use the API to integrate with ServiceCEO. Web Service A software system designed to support communication between two computers over a network up and running in the shortest possible time so that you can use it to run tools that use the API, such as the Outlook® Calendar Import.

Caution!

Caution:
This topic does not cover everything that is needed to setup an environment suitable for you to develop your own API applications. For details on configuring a development environment, see the Web Service Developer’s Guide (PDF document), located online or in the zipped API setup file.

Requirements

To install the API, you must have the following components installed:

  1. .NET "Dot Net" is a Microsoft® operating system platform that is designed to hide the boundaries between applications and the Internet. In other words, .NET will enable you to seamlessly connect to many different computers and services that will exchange and combine objects and data, instead of interacting with an application or a single Web site. Microsoft envisions this new technology as revolutionary, enabling Internet users to integrate fax, e-mail and phone services, centralize data storage and synchronize all of a user's computing devices to be automatically updated. They envision that software will be rented as a hosted service over the Internet, users will have access to their information on the Internet from any device, anytime, anywhere. .NET depends on four Internet standards: HTTP, XML, SOAP, and UDDI. 2.0. Note that .NET 2.0 is automatically installed with ServiceCEO 6.1+.

  2. IIS IIS (Internet Information Server) is IIS is Microsoft's business-class Web server. Although Apache boasts more total worldwide installations than IIS, many corporations choose IIS as their Web server because it is supported by a commercial organization. Some have criticized IIS in the past, though, for its alleged security weaknesses. IIS has improved over the years, supports many Web standards including SSL, and integrates well with other Microsoft Web technologies such as FrontPage. An administrator can manage IIS through a graphical console, the Internet Services Manager. version 5.5 or greater, if not already installed.

  3. ServiceCEO 6.1+.

Installing the ServiceCEO API Web Service

The ServiceCEO API Web Service acts as an intermediary between other applications and ServiceCEO's data and business logic.

Caution!

Caution:
If you are running Microsoft Vista, perform this step before installing the API Web Service:

  1. Open the Control Panel and double-click Programs and Features. The Windows Features dialog box appears.

  2. Navigate to Internet Information Services > Web Management Tools and select the IIS 6 Management Compatibility check box.

Note that you may need to have your IIS 6 CD available to install any additional components.

Follow these steps to install and configure the ServiceCEO API Web Service:

  1. Download the API Setup file from the Insight Direct Member Center. Click the ServiceCEO Downloads link.

    This compressed file contains the following files:

  2. Using a file compression tool like WinZIP, extract the files to your computer.

  3. Double-click ServiceCEOAPI.exe. The API Installer welcome page appears.

  1. Click Next. The License Agreement screen appears.

  1. Click the I accept the terms in the license agreement option button.

  2. Click Next. The Ready to Install the Program page appears.

  1. Click Install. The web service will install. This may take a few minutes. When complete, the Installation Completed page appears.

  1. Click Finish. The web service is now installed!

Back to the Table of Contents

Did you find this topic useful? Yes
No
I don't know		 Why?