Documentations

This document provides information on how to interact with the API.

Authentication

Before making API requests, ensure authentication by following these steps:

1. Visit the authentication endpoint: Sign In (with the provided credentials) to the application.
2. Click the "Manage" button on the relevant area to access the admin page.
3. In the admin page, click the login button for identification (if not signed in).

Webhooks

Webhooks are used to receive updates when asynchronous operations are completed. Follow these steps to register a webhook:

1. After signing in, navigate to the "Register Webhook" page.
2. Register the webhook with two URL input fields: the actual webhook URL and the Grant URL.
3. Both URLs should be exposed from your server and share the same domain. The Grant URL should support "OPTIONS" requests with the ‘X-dialog-engine-whtoken’ header, and the token in the header should match the token provided in the input field during registration.
4. This token verification is done to avoid abuse during webhook registration. If the grant URL returns the response header as expected, the webhook will be registered.

API Key

Generate an API Key to authenticate API calls:

1. Visit the "Generate API Key" page.
2. Press the "Generate API Key" button to create a new API Key.
3. Use any generated API key as an Auth header during API calls.

API Usage

Refer to the API documentation for detailed information:

API Swagger Docs: Swagger

    
        curl -X 'GET' \
            'http://192.168.145.211/dialog/api/v1/DialogEngine' \
            -H 'accept: */*' \
            -H 'Authorization: Bearer {API-key}'
    

A sample response could look like the following:

    
        [{"id":241,"title":"Sample Dialog","status":"Success"}]
    

More References

Get Started Docs

Sample console application link

API Documenations

Swagger API docs are available here