LogoLogo
  • About Hala.ai
  • Getting started with Hala
  • Hala Web Chat
  • Hala Platform
  • Platform Key concepts
    • Dashboard
      • Skills usage and chat history
    • User Management
    • Skills Kit
      • Dialog nodes
      • Conditions
      • Actions
      • Context
      • Output
        • Text
        • Text random
        • Quick reply
        • Video
        • Images
        • Forms
        • Tables (beta)
      • Behavior
    • Intents
    • Entities
    • Pre-built content
    • Context variables
    • Integrations
      • SAP (via Web Services)
      • ServiceNow
      • REST API
    • Actions
      • SAP (via Web Services)
      • ServiceNow
      • REST API
  • How to
    • Create a simple skill
    • Create a more complex skill
    • Create skill for SAP
    • Create skill for ServiceNow
    • Create the weather skill
    • Create skill with forms
  • help
    • Changelog
    • Support
    • Service Plan
  • reference
    • Articles
      • How AI empower sustainable growth of the organizations
      • How the Conversational AI Analytics will transform the business
      • Digital Skills as a Service (DSaaS)
      • Emerging Technologies and Enterprise Software
      • Identify the potential for automation
      • Few reasons to empower your ERP with Digital Assistant
      • AI Technology VS Value
      • SAP AMS Market Overview
Powered by GitBook
On this page
  • Overview
  • Adding the REST API

Was this helpful?

  1. Platform Key concepts
  2. Integrations

REST API

Last Updated: 19.10.2019

PreviousServiceNowNextActions

Last updated 5 years ago

Was this helpful?

Overview

With REST API, you can integrate any external application with Hala. After adding integration, you would need to create Actions related to your integration. And then, you can add actions into the Skills to make the API calls to your external application.

Adding the REST API

To add the integration with external application via REST API , go to the section "Integrations" and click "Add integration".

Select the "REST API" block and then enter the values for adding the integration with your application.

Provide the following information:

Integration name - you can specify any name for your integration via REST API.

Base URL - this field is optional, here you can provide the API provider base URL.

Authorization - there are next available authorization types:

  • API Key - An application programming interface key is a unique identifier used to authenticate a user, developer, or calling program to an API.

  • Bearer Token - Bearer Tokens are the predominant type of access token used with OAuth 2.0. A Bearer Token is an opaque string, not intended to have any meaning to clients using it. Some servers will issue tokens that are a short string of hexadecimal characters, while others may use structured tokens such as JSON Web Tokens.

  • Basic auth - Basic access authentication is a method for an HTTP user agent (e.g. a web browser) to provide a user name and password when making a request. The BA mechanism provides no confidentiality protection for the transmitted credentials. They are merely encoded with Base64 in transit, but not encrypted or hashed in any way. Therefore, Basic Authentication is typically used in conjunction with HTTPS to provide confidentiality.

  • OAuth 2.0 - OAuth 2.0 is the industry-standard protocol for authorization. OAuth 2.0 does not support signature, encryption, channel binding, or client verification. It relies completely on TLS for some degree of confidentiality and server authentication

When you will enter all the values, please click "Save". Now you have added the integration with external application via REST API.

Next step: Go to the section Actions and build your actions in connection to created integration.