# Bot API

Bot API is an API from 3Dolphins SRM ChatBot which can be used for integration needs with other systems.

Login as ***‘Supervisor’** or **‘Administrator’***, go to ***API*** menu and click the ***Bot API*** menus, then you will see a bot API page such as images below.

![Bot API](https://765826444-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MNQidQwa-0K9_KnQpoc%2F-MUl_6njDiMgL-x0UfJp%2F-MUl_cZFQngKEkeSzfFy%2Fimage.png?alt=media\&token=a73a23a4-3204-4559-90ef-aeac66fa2d18)

| Field/Notes      | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Method           | Method indicates the allowed interactions (such as GET, POST, PUT or DELETE) with the resource.                                                                                                                                                                                                                                                                                                                                                               |
| Media Type       | Specifies the format of the data as type/subtype application/json.                                                                                                                                                                                                                                                                                                                                                                                            |
| URL              | This field supports user attributes, they will be URL-encoded with your request.                                                                                                                                                                                                                                                                                                                                                                              |
| Body             | The Body of the 3Dolphins API represents the body of the response/request.                                                                                                                                                                                                                                                                                                                                                                                    |
| Status           | <p>HTTP response status codes indicate whether a specific HTTP request has been successfully completed. Responses are grouped in five classes :<br>1. Informational responses (<code>100</code>–<code>199</code>),<br>2. Successful responses (<code>200</code>–<code>299</code>),<br>3. Redirects (<code>300</code>–<code>399</code>),<br>4. Client errors (<code>400</code>–<code>499</code>),<br>5. Server errors (<code>500</code>–<code>599</code>).</p> |
| Response         | The Response interface of the 3Dolphins API represents the response to a request.                                                                                                                                                                                                                                                                                                                                                                             |
| Server           | Application Url                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| Username         | Username credential                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| Password         | Password credential                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| GeneratedTokenId | Generated token id                                                                                                                                                                                                                                                                                                                                                                                                                                            |
