[1] Introduction

Last modified by admin on 2023/03/06 18:06

1.  Overview

This is an REST API that exposes entities and their relationships using well defined access, navigation and modification rules. The akaBot Center API Guide is meant to help you easily access and manage all resources available in the Center web interface.

Node: All examples have been built using the http://botcenter.akabot.io Center address. Please use your own Center address when building requests.

2. Authentication

2.1. Robot

The authentication system for the akaBot Center API uses a bearer token. It requires you to use the robotKey and machineName.

To authenticate to the akaBot Center API do the following:

a. Make a POST request to the http://botcenter.akabot.io/api/Account URL

image-20230306180029-1.png

Request

image-20230306180029-2.png

image-20230306180029-3.png

Response

image-20230306180029-4.png

b. Copy to the Clipboard the token from the HTTP response, from the "id_token"

c. The token must be used in all future requests, in the following format:

image-20230306180029-5.png

2.2. Acount

The authentication system for the akaBot Center API uses a bearer token. It requires you to use the username and password.

To authenticate to the akaBot Center API do the following:

a. Make a POST request to the http://botcenter.akabot.io/api/authenticate URL

image-20230306180029-6.png

Request

image-20230306180029-7.png

image-20230306180029-8.png

Response

image-20230306180029-9.png

a. Copy to the Clipboard the token from the HTTP response, from the "id_token"

b. The token must be used in all future requests, in the following format:

image-20230306180029-10.png

  
Navigation