Difference between revisions of "Outlook Tickets Plugin Specs"

From Idrive
Jump to navigation Jump to search
 
(4 intermediate revisions by the same user not shown)
Line 8: Line 8:
 
== Functional requirements ==
 
== Functional requirements ==
  
"Ticket" button actions :
+
1. "Ticket" button actions :
  
 
  Try to find ticket ID on the email's subject
 
  Try to find ticket ID on the email's subject
Line 14: Line 14:
 
   RE: [C000078] Idrive Support Ticket Title
 
   RE: [C000078] Idrive Support Ticket Title
 
   C000078 = Ticket ID;
 
   C000078 = Ticket ID;
 +
 +
Send a GET http request to : http://admincenter.idrive.pro/adm/home/?Module=TicketsAPI&Action=CheckTicket&TicketId=xxx&Token=crypt-string;
 +
 +
Process Response
 +
Response format: <response>FALSE</response> or  <response>TRUE</response>
 +
 
  If Ticket ID is found, check "Existing" radio button.
 
  If Ticket ID is found, check "Existing" radio button.
 
  If Ticket ID is not found check "New" radio button.
 
  If Ticket ID is not found check "New" radio button.
 +
Enable "Add" button.
 +
 +
 +
 +
2. "Add" button actions
 +
 +
A. Add a new ticket
 +
 +
Send a POST http request to : http://admincenter.idrive.pro/adm/home/?Module=TicketsAPI&Action=NewTicket&Token=crypt-string;
 +
POST parameters:
 +
Subject => email subject
 +
Description => email content
 +
SentBy => sender email
 +
 +
Process Response:
 +
Response format: <response>FALSE</response> or  <response>TRUE</response>
 +
 +
B. Post to existing ticket
 +
Send a POST http request to : http://admincenter.idrive.pro/adm/home/?Module=TicketsAPI&Action=EditTicket&Token=crypt-string;
 +
TicketID => ticket Id extracted from email subject
 +
Description => email content
 +
SentBy => sender email
 +
 +
Process Response:
 +
Response format: <response>FALSE</response> or  <response>TRUE</response>
 +
 +
3. Build "token" crypt string
 +
Use mcrypt_encrypt(MCRYPT_3DES, KEY, DATA, MCRYPT_MODE_CBC, $iv)
 +
PHP exemple: http://php.net/manual/en/function.mcrypt-encrypt.php
  
 
== External Interface Requirements ==
 
== External Interface Requirements ==
 +
 +
Ticket [button] New [radio button] Existing [radio button] Add [button]

Latest revision as of 08:12, 9 August 2013

Introduction

Description and priority

Action/result

  • Create a new ticket based on emails subject and content.
  • Add entire content of the email to an existing ticket.

Functional requirements

1. "Ticket" button actions :

Try to find ticket ID on the email's subject
 Email subject format:
 RE: [C000078] Idrive Support Ticket Title
 C000078 = Ticket ID;
Send a GET http request to : http://admincenter.idrive.pro/adm/home/?Module=TicketsAPI&Action=CheckTicket&TicketId=xxx&Token=crypt-string;
Process Response
Response format: <response>FALSE</response> or  <response>TRUE</response>
If Ticket ID is found, check "Existing" radio button.
If Ticket ID is not found check "New" radio button.
Enable "Add" button.


2. "Add" button actions

A. Add a new ticket

Send a POST http request to : http://admincenter.idrive.pro/adm/home/?Module=TicketsAPI&Action=NewTicket&Token=crypt-string;
POST parameters:
Subject => email subject
Description => email content
SentBy => sender email
Process Response:
Response format: <response>FALSE</response> or  <response>TRUE</response>
B. Post to existing ticket
Send a POST http request to : http://admincenter.idrive.pro/adm/home/?Module=TicketsAPI&Action=EditTicket&Token=crypt-string;
TicketID => ticket Id extracted from email subject
Description => email content
SentBy => sender email
Process Response:
Response format: <response>FALSE</response> or  <response>TRUE</response>

3. Build "token" crypt string

Use mcrypt_encrypt(MCRYPT_3DES, KEY, DATA, MCRYPT_MODE_CBC, $iv)
PHP exemple: http://php.net/manual/en/function.mcrypt-encrypt.php

External Interface Requirements

Ticket [button] New [radio button] Existing [radio button] Add [button]