API Demo Installation

Install DChat API Demo

Legacy Web Forms sample. These steps require the older ChatApi.asmx deployment and a separate API demo package. They do not apply to the current .NET 8 download, and the sample package is not available from this site. Get the current package for a new installation.

DChat API Demo is a simple Web API application. It demonstrates the powerful capabilities of DChat API.

The examples below use chat.example.com for the main DChat deployment and api-demo.example.com for the companion API demo site. Replace those placeholders with your own domains.

1. Copy API Demo to your application directory

Unzip the install zip to a new folder where you want the site to be hosted from (eg C:\inetpub\APITestWeb).

The API demo files copied into a new website folder

2. Configure the Web Site in IIS

Open up IIS Manager, select the Default Web Site (under Sites) and click the Stop button. Now, right click on Sites and select Add Website...

Provide a site name and the folder you want the site to be hosted from.

Creating the API demo website in IIS Manager

3. Modify DChat Web site web.config to register ChatApiNotificationUrl and ChatApiKey

ChatApiKey is used to create a trusted connection between the main DChat deployment (chat.example.com) and the API demo site (api-demo.example.com).

Please open the main DChat site's web.config and register the notification URL used by the API demo listener, for example https://api-demo.example.com/handle_chatapi_notification.ashx. The main DChat deployment sends event notifications to that listener.

The DChat web.config with ChatApiNotificationUrl registered

4. Modify API Demo web.config to register ChatApiServiceUrl and ChatApiKey

ChatApiKey in the API demo web.config must match the ChatApiKey configured in the main DChat deployment.

Please open the API demo site's web.config and register the service URL exposed by your DChat deployment, for example https://chat.example.com/ChatApi.asmx.

The API demo web.config with ChatApiServiceUrl and ChatApiKey registered

5. You are all set!

If you installed the API Demo correctly, you will see the following screen that lets you know you're good to go.

The completed API demo configuration, ready to test

6. Check the API Demo site's App_Data folder

Event notifications received from the main DChat deployment are stored in the demo site's log files. Reviewing those files is a practical way to understand how the API sample handles notifications.

Notification files written into the API demo App_Data folder

Self-hosted customer support software

Deploy live chat on your own terms, not on someone else's pricing model.

DChat gives you the installable server, web dashboard, website widget, and desktop agent tools in one self-hosted product, with live chat free to run, and an AI agent that answers, acts with the approvals you set and hands off to your team when you want one. Run it on infrastructure you trust, on the model you choose.

Deployment

Install on Windows or Linux, behind IIS or Nginx, in a VM, or in Docker if that fits your stack.

Commercial model

Live chat is free with unlimited agents. Premium, with the AI agent, is billed per agent per month, never per conversation.

AI Flexibility

Run the AI agent on a local Ollama model, or connect OpenAI and Anthropic with your own provider accounts.