Camlin API Channel*


CamlinConnect API channel provides API endpoints that can generate API responses as per the configured template data. CamlinConnect API channel can be used for

  • Providing rest endpoints for a business flow that is either configured in Camlin or integrated with Camlin

  • Providing rest endpoints for Databases

Camlin REST-based API allows a client to interact and drive a Camlin project call-flow. The APIs are dynamic in nature due to the dynamic nature of each project but the request & response follows a structure that is mentioned in this specification. The API supports different data formats such as json/plain.

Endpoint

Inbound URL

protocol://hostname:port/nuassist/rest/in/api/{projectToken}/{endpoint}/..

The URL up to project token is the base URL, further added path params are the actual endpoints of an API available/configured on CamlinConnect API Channel. This endpoint path paramater will be mapped to a special Camlin variable called “inputApiUri”. So to capture request endpoint, we should create this variable in the API application.

Methods:

  • GET

  • POST

  • PUT

  • DELETE

  • OPTIONS

  • COPY

Request Header:

  • BASIC auth header

Request Parameters

Parameter

Mandatory

Values

Default Value

Description

apiSessionId

{apiSessionId}

To mantain an API session

ht

{handoffToken}

Handoff token in multi-channel applications. See Camlin Multi-Channel and Multi-modal

Custom parameter

Any other variable that you want to set in camlin app : This is a generic feature on Camlin inbound channels to set any of Camlin app variable with request parameter

Sample URL

https://www.camlinconnect.com/nuassist/rest/in/api/wifihandler/campus?cec=MIL

Request Body

  • json

  • plain

  • x-www-form-urlencoded

You can set variables that you want to set in Camlin app by sending paramaters in request body in json or x-www-form-urlencoded format

Response Format

  • json

  • plain

See Channel Settings for details of how to configurate project settings for API channel

See API Interaction for details of how to configurate an API interaction

See Create an API endpoint for an example of how to build an API

Search