Introduction
IntelliBuddies provides Client APIs and Models for your applications to integrate and work with our Buddies. Typically, use our APIs to submit tasks to our Buddies and get the status update on those tasks. But, we have gone multiple steps further to support more from the integration angle. You can do almost everything inside the Control Room using our APIs.
You can use the IntelliBuddies client object model to retrieve, update, and manage your Automation entities inside the IntelliBuddies Control Room.
Assembly Reference
When you want to work with our Client API, you need to add the following .Net Core assemblies to your project:
IntelliBuddies.Client.API.dll
You can use IntelliBuddies Automation APIs only with IntelliBuddies Enterprise Edition.
You can find the above assembly inside the IntelliBuddies Control Room installation folder.
You must add the following statements to the code file.
using IntelliBuddies.Client;
using IntelliBuddies.Client.Models;
API Categories
To make it easier to understand, we have categorized our APIs according to our Control Room Repository entities, and that way, you can map our APIs with their functionality. We have also defined the models used in data communication to make it easier to integrate without knowing the entity details.
Providing each API documentation with an example for understanding usage should help you build your integration faster.
The following table details our API categories and their brief description.
| Category | Description |
|---|---|
| ControlRoomContext | APIs and Models used for connecting to IntelliBuddies Control Room. |
| Jobs | APIs and Models to initiate, monitor, and control your automation jobs |
| Bots | APIs and Models to set up and manage your Assistant Buddies |
| SmartBuddies | APIs and Models to set up and manage your Smart Buddies |
| Process | APIs and Models to handle your automation processes |
| Schedules | APIs and Models to set up and manage your time triggers for your automation |
| FileSystemTriggers | APIs and Models to set up and manage your file system triggers for your automation |
| EmailTriggers | APIs and Models to set up and manage your email triggers for your automation |
| Logs | APIs and Models to audit your automation jobs |
| EnterpriseVariables | APIs and Models to manage your Enterprise Variables |
| Tasks | APIs and Models to manage your human tasks assigned by Buddies |
| Users | APIs and Models to administer your automation users |
| Roles | APIs and Models to manage your automation roles |
| Process Instance | APIs and Models to create and manage your process instances |
| Connection | APIs and Models to manage your connections |