List all agents

REQUEST
GET

RESPONSE
200 OK
[
{
state: W,
installCode: 123456789,
id: xxxxxxxxxxxxxxxxxx,
description: Description 1,
name: Name 1
},
{
state: N,
osType: 1,
id: xxxxxxxxxxxxxxxxxx,
supportedApplications: filesystem;texteditor;logwatch;resource;desktop,
description: Description 2,
name: Name 2
},
...
]

Delete an agent

REQUEST
DELETE /id=<agent id>

RESPONSE
200 OK
{
status: 200
}

Modify an agent

REQUEST
PUT
{
name: <name of agent>,
description: <description of agent>
}

RESPONSE
200 OK
{
status: 200
}

Create an agent

REQUEST
POST
{
name: <name of agent>,
description: <description of agent>
}

RESPONSE
200 OK
{
id: <id of agent created>,
installCode: <code to install agent>
}

Agent resource

The url to perform operations on agents resource is:

https://www.apiremoteaccess.com/en/api/json/agents

The agent resource information is:

id:Identify the agent id.
name:Name of agent.
description:Description of agent.
state:Indicates the state of an agent:
W = Wait installation
N = Online
F = Offline
D = Disabled
osType:Indicates the OS where agent is installed:
1 = Windows
2 = Linux
3 = Mac OS
installCode:This code enables to install agent (Available is state=W).
supportedApplications:List of applications supported by agent: filesystem;texteditor;logwatch;resource;desktop

Get Credit Transactions

REQUEST
GET /request=creditTransactions&days=<days>

RESPONSE
200 OK
[
{
id: 5fkiswe7ntigf93,
dateTimeUTC: 2018-12-01T12:06:09Z,
ticketCurrency: USD,
ticketPrice: 0.1,
type: ADD_SERVICES,
details: {
unitCost: mo,
agentQuantity: 7,
agentCost: 2,
channelBasicQuantity: 3,
channelBasicCost: 50,
refMonth: 12
},
amount: -164
},
{
id: h95tg7erk3j43e5,
dateTimeUTC: 2018-11-16T09:45:12Z,
ticketCurrency: USD,
ticketPrice: 0.1,
type: ADD_SERVICES,
details: {
unitCost: mo,
agentQuantity: 3,
agentCost: 2,
channelBasicQuantity: 1,
channelBasicCost: 50,
refMonth: 11,
paidDays: 15
},
amount: -28
},
{
id: e2hj4fz9g7p35hu,
dateTimeUTC: 2018-11-01T11:22:45Z,
ticketCurrency: USD,
ticketPrice: 0.1,
type: ADD_SERVICES,
details: {
unitCost: mo,
agentQuantity: 4,
agentCost: 2,
channelBasicQuantity: 2,
channelBasicCost: 50,
refMonth: 11
},
amount: -108
},
{
id: Dhr53dwr46gdwe36,
dateTimeUTC: 2018-12-05T19:35:62Z,
ticketCurrency: USD,
ticketPrice: 0.1,
type: ADD_CREDIT,
details: {
},
amount: 1000
},
...
]

Remove Services

Decrease the number of allowed agents/channels. To remove channels you must specify the Ids of the channels that you want remove. Be careful, your allowed agents must be greater than installed agents. Removing a service does not have an immediate effect on the your credit balance, however the following month you will pay only the current number of allowed agents/channels.

REQUEST
PUT /request=removeServices
{
agents: <num. agents to remove>,
channelsIDs: [<id 1>, <id 2>, <id 3>, ...]
}

RESPONSE
200 OK
{
agentsRemoved: 2,
channelsBasicRemoved: 3,
channelsRemoved: 3
}

Add Services

Increase your number of allowed agents/channels. For each added channel a new id will be generated. Be careful, this requires purchasing agents/channels using your credits. You can check the cost of the services by setting simultate=true in query string.

REQUEST
PUT /request=addServices[&simulate=true]
{
agents: <num. agents to add>,
channelsBasic: <num. channels to add>
}

RESPONSE
200 OK
{
agentsAdded: 3,
channelsBasicAdded: 2,
channelsBasicAddedIDs: [5,6],
channelsAdded: 2,
cost: {
transactionID: dFerx32dGTt8tg2sd,
ticketCurrency: USD,
ticketPrice: 0.1,
unitCost: mo,
agentQuantity: 3,
agentCost: 2,
channelBasicQuantity: 1,
channelBasicCost: 50,
refMonth: 11,
paidDays: 15,
total: 28
}
}

Get Account Info

REQUEST
GET /request=info

RESPONSE
200 OK
{
email: Your Email,
company: My Company,
firstName: First Name,
lastName: Last Name,
country: US,
address1: My street, 1,
address2: My street, 2,
postalcode: 123456,
city: My City,
stateprovince: My state,
telephone1: 123456,
fax: 123456,
vatid: 123456,
regnum: 123456,
localeID: en_US,
timeZone: America/Los_Angeles,
country: US,
credit: 1520,
agentsInstalled: 0,
agentsAllowed: 3,
channelsBasicAllowed: 4,
channelsAllowed: 4,
priceList: {
unit: mo,
ticketCurrency: USD,
ticketPrice: 0.1,
agentCost: 3,
channelBasicCost: 60
},
cost: {
unit: mo,
agents: 9,
channelsBasic: 240,
total: 249
},
channelsBasicIDs: [0,3,4,6]
}

Account resource

The url to perform operations on account resource is:

https://www.apiremoteaccess.com/en/api/json/account

This resource allows you to manage your account, add or remove services (agents/sessions allowed), get information regarding your credit and transactions. Credit and costs are expressed in “DWService API ticket” in the “priceList” block you can see the price for one ticket.