RocTik Help Documentation



RocTik - Cloud Based Ticketing System, which is easily integrable with your existing system. Easy to maintain, easily scalable and more over it is your system, not a seperate one. This Help Documentation provides steps to Integrat with your system and how easy is it to use through Usability document. You can also use developer APIs, which are mentioned below in detail. We have used very simple languages like PHP and Javascript.


Download Usability Document
Download Web Integration Document
Download Android Integration Document

RocTik API Guide


RocTik Application Programming Interface are for Ticketing System. They are Rest APIs. You can do all operations as REST allows like CRUD.


APIs List


Name of the API Short Description
List Tickets This will list down all the tickets for that subscriber.
Create Ticket Creates Ticket for that particular subscriber. Admin or Agent can create ticket on behalf of subscriber.
Update Ticket Updates Ticket.The status and the message can be updated.
Get Ticket Information Get Ticket Information.The status and the messages and other details of a Particular Ticket.
Agent Login Agent can be logged into the system with his details.
Agent Logout Agent Logs out of the system.
List Tickets Gets List of Tickets for the agent. One request can have 200 Tickets at a time.
Get Ticket Gets details of Tickets assigned to the agent.
Update Ticket Agent can update Ticket status and give appropriate message.
Get Ticket Stats Agent can get statistics of the tickets.
Create Company Admin can create the company by giving all required details.
Admin Login Admin can be logged into the system with his details.
Admin Logout Admin Logs out of the system.
Create Support Staff Admin can create support staff.
List Support Staff All existing support staff is Listed.
Delete Support Staff Existing support staff can be deleted from the List.
List Tickets Gets List of Tickets for the Admin. One request can have 200 Tickets at a time.
Get Ticket Gets details of Tickets assigned to any agent.
Update Ticket Admin can update Ticket status and give appropriate message.
Get Ticket Stats Admin can get statistics of the tickets.


Listing of Tickets of any Subscriber


This API is used for list tickets/requests raised by a subscriber.

URL https://evayadesk.com/subscriber/v1/request
Method GET
Input 1. apitoken
2. subscriberid
Output 200 OK+ application/json
[{requestid:< requestid >,title:< request title >,category:< category > ,Priority:< priority >,initiator:< subscriberid >,requeststatus:< CREATED|ASSIGNED|CLOSED >,created:< created date >,closed:< closed date >}]
on Success
{error:< Reason >} on Failure
4xx/5xx ERROR with reason on failure


Top/Beginning


Adding Tickets


This API is used for Add tickets/requests on behalf of a subscriber by Agent or Admin.

URL https://evayadesk.com/subscriber/v1/request
Method POST
Input Mandatory
1. apitoken
2. title:< Title – 64 characters >
3. message:< Message - max 250 characters >
Optional
4. category
5. priority
Output 200 OK+ application/json
{“success”: < requestid >} on Success
{error: < Reason >} on Failure
4xx/5xx ERROR with reason on failure


Top/Beginning


Updating Tickets


This API is used for update tickets/requests.

URL https://evayadesk.com/subscriber/v1/request
Method PUT
Input
1. apitoken
2. message: Message - max 250 characters
3. requestid
Output 200 OK+ application/json
{“success”: < requestid >} on Success
{error: < Reason > } on Failure
4xx/5xx ERROR with reason on failure


Top/Beginning


Get Ticket Information


This API is used to get any one ticket/request information.

URL https://evayadesk.com/subscriber/v1/request/id=< ticketid >
Method GET
Input
1. apitoken
2. subscriberid
Output 200 OK+ application/json
{"requestid":"< requestid >","category":<category>,"priority":<priority>,"initiator":"< subscriberid >","requeststatus":"< CREATED|ASSIGNED|CLOSED >","data":[{"created":<timestamp >,"updatedby":"<updater >","message":"<message >"}],”created”:<created date >,”closed”:<closed date >} on Success
{error:< Reason >} on Failure
4xx/5xx ERROR with reason on failure


Top/Beginning


Agent Login


This API is for Agent Logging into the system.

URL https://evayadesk.com/support/v1/login
Method GET
Input
1. apitoken
2. useremail
3. password
Output 200 OK+ application/json
{"idcompany: < idcompany >,"status: < ACTIVE|INACTIVE >,“username”:< username >,”useremail”:< useremail >,”role”:< role >,”staffstatus”:< ACTIVE|INACTIVE >} on Success
{error: < Reason >} on Failure
4xx/5xx ERROR with reason on failure


Top/Beginning


Agent Logout


This API is for Agent Logging out of the system.

URL https://evayadesk.com/support/v1/logout
Method GET
Input
1. apitoken
2. useremail
Output 200 OK+ application/json
{ "success":< useremail >; } on Success
{error: < Reason >} on Failure
4xx/5xx ERROR with reason on failure


Top/Beginning


Listing of Tickets of any Agent


This API is used for list tickets/requests assigned to any Agent.

URL https://evayadesk.com/support/v1/request
Method GET
Input 1. apitoken
2. supportemail
Output 200 OK+ application/json
[{requestid:< requestid >,title:< request title >,category:< category > ,Priority:< priority >,initiator:< subscriberid >,requeststatus:< CREATED|ASSIGNED|CLOSED >,created:< created date >,closed:< closed date >}]
on Success
{error:< Reason >} on Failure
4xx/5xx ERROR with reason on failure


Top/Beginning


Get Ticket Information by an Agent


This API is used to get any one ticket/request information by an agent.

URL https://evayadesk.com/support/v1/request/id=< ticketid >
Method GET
Input
1. apitoken
2. supportemail
3. requestid
Output 200 OK+ application/json
{"requestid":"< requestid >","category":<category>,"priority":<priority>,"initiator":"< subscriberid >","requeststatus":"< CREATED|ASSIGNED|CLOSED >","data":[{"created":<timestamp >,"updatedby":"<updater >","message":"<message >"}],”created”:<created date >,”closed”:<closed date >} on Success
{error:< Reason >} on Failure
4xx/5xx ERROR with reason on failure


Top/Beginning


Updating Tickets by Agent


This API is used for update tickets/requests.

URL https://evayadesk.com/support/v1/request
Method PUT
Input
1. apitoken
2. message: Message - max 250 characters
3. requestid
Output 200 OK+ application/json
{“success”: < requestid >} on Success
{error: < Reason > } on Failure
4xx/5xx ERROR with reason on failure


Top/Beginning


Get Tickets Statistics by Agent


This API is used for get tickets/requests statistics.

URL https://evayadesk.com/support/v1/request/stat
Method GET
Input
1. apitoken
2. period
3. supportemail
Output 200 OK+ application/json
{“open”: < # open req >,”closed”:<num closed,”avgclosuretime”:<average closure time in days >,dailystat[{date:< >,open:< >,closed:< > }]} on Success
{error: < Reason > } on Failure
4xx/5xx ERROR with reason on failure


Top/Beginning


Create Company by Admin


This API is used for creating Company.

URL https://evayadesk.com/admin/v1/company
Method POST
Input
1. companyname
2. adminname
3. email
4. phonenumber
5. password
6. passphrase
7. plan
Output 200 OK+ application/json
{“apitoken”: < # apitoken >,”adminname”:< adminname $gt;,”email ”:< admin email > } on Success
{error: < Reason > } on Failure
4xx/5xx ERROR with reason on failure


Top/Beginning


Admin Login


This API is for Admin Logging into the system.

URL https://evayadesk.com/admin/v1/login
Method GET
Input
1. apitoken
2. email
3. password
4. passphrase
Output 200 OK+ application/json
{"idcompany: < idcompany >,"status: < ACTIVE|INACTIVE >,adminname:< adminname >,”email”:< email >} on Success
{error: < Reason >} on Failure
4xx/5xx ERROR with reason on failure


Top/Beginning


Admin Logout


This API is for Admin Logging out of the system.

URL https://evayadesk.com/admin/v1/logout
Method GET
Input
1. apitoken
2. email
Output 200 OK+ application/json
{ "success":< useremail >; } on Success
{error: < Reason >} on Failure
4xx/5xx ERROR with reason on failure


Top/Beginning


Create Support Staff by Admin


This API is used for creating support staff by Admin.

URL https://evayadesk.com/admin/v1/support
Method POST
Input
1. apitoken
2. username
3. useremail
4. role
5. password
Output 200 OK+ application/json
{ "success": < useremail > } on Success
{error: < Reason > } on Failure
4xx/5xx ERROR with reason on failure


Top/Beginning


List Support Staff by Admin


This API is used for List support staff by Admin.

URL https://evayadesk.com/admin/v1/support
Method GET
Input
1. apitoken
Output 200 OK+ application/json
{ "apitoken": < apitoken >, "companyname": < companyname >, "username": < username >, "useremail": < useremail >, "role": < role >, "status": < status > } on Success
{error: < Reason > } on Failure
4xx/5xx ERROR with reason on failure


Top/Beginning


Delete Support Staff by Admin


This API is used for Delete support staff by Admin.

URL https://evayadesk.com/admin/v1/support
Method DELETE
Input
1. apitoken
2. email
Output 200 OK+ application/json
{“success”:} on Success
{error: < Reason > } on Failure
4xx/5xx ERROR with reason on failure


Top/Beginning


Listing of Tickets - Admin


This API is used for list tickets/requests for that company by Admin.

URL https://evayadesk.com/admin/v1/request
Method GET
Input 1. apitoken
Output 200 OK+ application/json
[{requestid:< requestid >,title:< request title >,category:< category > ,Priority:< priority >,initiator:< subscriberid >,requeststatus:< CREATED|ASSIGNED|CLOSED >,created:< created date >,closed:< closed date >}]
on Success
{error:< Reason >} on Failure
4xx/5xx ERROR with reason on failure


Top/Beginning


Get Ticket Information - Admin


This API is used to get any one ticket/request information by Admin.

URL https://evayadesk.com/admin/v1/request/id=< ticketid >
Method GET
Input
1. apitoken
3. requestid
Output 200 OK+ application/json
{"requestid":"< requestid >","category":<category>,"priority":<priority>,"initiator":"< subscriberid >","requeststatus":"< CREATED|ASSIGNED|CLOSED >","data":[{"created":<timestamp >,"updatedby":"<updater >","message":"<message >"}],”created”:<created date >,”closed”:<closed date >} on Success
{error:< Reason >} on Failure
4xx/5xx ERROR with reason on failure


Top/Beginning


Updating Tickets - Admin


This API is used for update tickets/requests.

URL https://evayadesk.com/admin/v1/request
Method PUT
Input
1. apitoken
2. message: Message - max 250 characters
3. requestid
Output 200 OK+ application/json
{“success”: < requestid >} on Success
{error: < Reason > } on Failure
4xx/5xx ERROR with reason on failure


Top/Beginning


Get Tickets Statistics - Admin


This API is used for get tickets/requests statistics for the whole company by admin.

URL https://evayadesk.com/admin/v1/request/stat
Method GET
Input
1. apitoken
2. period
Output 200 OK+ application/json
{“open”: < # open req >,”closed”:<num closed,”avgclosuretime”:<average closure time in days >,dailystat[{date:< >,open:< >,closed:< > }]} on Success
{error: < Reason > } on Failure
4xx/5xx ERROR with reason on failure


Top/Beginning