In order to interact with the DataKnowl API, your application must authenticate.
Authentication is based on two keys:
- AccessKeyID
- SecretAccessKey
To authenticate using these master keys, use HTTP Basic Auth (RFC 7617) with the username
set to your AccessKeyID and the password set to your SecretAccessKey.
Your AccessKeyID and SecretAccessKey can be found on your Developers Dashboard.
The AccessKeyID is used to identify the user. SecretAccessKey is never sent or transmitted.
Authentication is implemented by passing parameters via HTTP headers
Parameters are:
knowl
Header |
Value |
Description |
Authorization |
Authorization: Basic <credentials> |
|
AccessKeyId |
Key used to identify the user |
|
Timestamp |
The timestamp of the request |
|
Signature |
The signature |
Empty for Basic Auth |
knowlExample
curl -v -X POST -H "Content-type: application/x-www-form-urlencoded; charset=UTF-8"
-H "AccessKeyId: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
-H "Timestamp: 1571411606301"
-H "Signature: "
-u {AccessKeyId}:{SecretAccessKey}
-d "sequence:text=Where is the nearest office ?"
https://eu-central.dcs.dataknowl.com/v1/vagent/{VAGNT}/conv/{VACNV}/sequence/process
where:
{VAGNT} is the V-Agent RID
{VACNV} is the Conversation RID, or NEW to start a new conversation