Giter VIP home page Giter VIP logo

ace-knowledge-docs's Introduction

NOTE: This is widgets V4 documentation. Widgets V3 documentation. Information about widget versions.

Humany Technical Documentation

Technical documentation on humany API, widgets and integration options

Overview

Humany supports a number of integration options. Depending on your use case you may prefer to use specialized plugins, a more general plugin API, direct REST integration or webhook actions.

Another consideration is type of interface being targeted. There are two main types of interface widgets - conversational and view-based.

View Based Widgets (Inline and Floating)

The following picture describes the relation between API options in a view-based widget such as inline or floating.

API Overview

Conversational Widgets (Bot)

The following picture describes the relation between API options in the bot conversational widget.

API Overview

Widget APIs

CSS

Speialized Plugin APIs

Tracking

Chat

Callback

Adapter

Generic Plugin API

Messages

Parameters

ServiceClient

Widget UI

REST APIs

Humany widgets communicate with the backend service through a REST API. This section is directed at developers who aim at integrating with this API without using our widget APIs.

Read more and implementation details

Matching API

Search for answers and retrieve content from the knowledge base.

Read more

Notices API

List notices, news and alerts.

Read more

Contact API

List and navigate to contact methods and post form data.

Read more

Conversation API

This API is subject to change and supported.

Knowledge Base API

This API is subject to change and supported.

Webhook

Pass information posted to the Web Service contact method to an external web hook and display the response to the user in the web widget.

Read more

SEO

Read more

ace-knowledge-docs's People

Contributors

basantosxvi avatar bratn avatar donami avatar jwmb avatar laurilubi avatar libardo avatar lowfendaahl avatar narkos avatar terrimad avatar theomuller avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.