Produced by Araxis Merge on 5/25/2018 9:22:54 AM Central Daylight Time. See www.araxis.com for information about Merge. This report uses XHTML and CSS2, and is best viewed with a modern standards-compliant browser. For optimum results when printing this report, use landscape orientation and enable printing of background images and colours in your browser.
| # | Location | File | Last Modified |
|---|---|---|---|
| 1 | C:\AraxisMergeCompare\Pri_un\ZIP\DSM-cif\Direct_API\application\views\api\onboarding\services | restore_message.php | Tue May 22 13:19:28 2018 UTC |
| 2 | C:\AraxisMergeCompare\Pri_re\ZIP\DSM-cif\Direct_API\application\views\api\onboarding\services | restore_message.php | Thu May 24 22:24:44 2018 UTC |
| Description | Between Files 1 and 2 |
|
|---|---|---|
| Text Blocks | Lines | |
| Unchanged | 5 | 258 |
| Changed | 4 | 10 |
| Inserted | 0 | 0 |
| Removed | 0 | 0 |
| Whitespace | |
|---|---|
| Character case | Differences in character case are significant |
| Line endings | Differences in line endings (CR and LF characters) are ignored |
| CR/LF characters | Not shown in the comparison detail |
No regular expressions were active.
| 1 | <?php | |
| 2 | /** | |
| 3 | * @package direct-as -a-service | |
| 4 | * @subpack age views | |
| 5 | * @fileso urce | |
| 6 | */ /** */ | |
| 7 | ||
| 8 | $t his->load- >view('api /header'); | |
| 9 | $t his->load- >view('api /nav'); | |
| 10 | ?> | |
| 11 | <h1><a h ref="/onbo arding/doc umentation /" class=" underline" >Documenta tion</a> & rarr; /dir ect/messag es/restore - POST</h 1> | |
| 12 | <p>The R estore Mes sage web s ervice all ows author ized appli cations to restore m essage to a folder i f that fol der still exists and can be ac cessed by sending a POST reque st to /dir ect/messag es/restore .</p> | |
| 13 | <h3>Auth entication </h3> | |
| 14 | <p> | |
| 15 | The API au thenticati on utilize d is based upon hash message a uthenticat ion code ( HMAC). HMA C is an au thenticati on method that combi nes a cryp tographic hash funct ion with a secret cr yptographi c key. Aft er the suc cessful re gistration of an app lication o n the API, a public and privat e key like the examp le below w ill be pro visioned f or its use . | |
| 16 | </p> | |
| 17 | <p class ="code"> | |
| 18 | Public Key : REDACTED | |
| 19 | <br/>Priva te Key: RE DACTED | |
| 20 | </p> | |
| 21 | <p> | |
| 22 | On every r equest tha t an appli cation sen ds to the API they m ust includ e an Autho rization h eader. The authoriza tion heade r is a str ing that t he API wil l utilize to confirm the ident ity, and t he message content, of the sen der. The a uthorizati on header consists o f three pa rts. The f irst part is the API identifie r, represe nted by th e word "DA AS", which stands fo r Direct a s a Servic e. The API identifie r is follo wed by a s pace that separates it from th e identify ing conten t. The ide ntifying c ontent con sists of t he unique public key and the b ase64 enco ded HMAC h ash genera ted by the request c ontent and the priva te key, de limited by a colon. An example of the au thorizatio n header i s below. | |
| 23 | </p> | |
| 24 | <p class ="code"> | |
| 25 | Authorizat ion: DAAS REDACTED | |
| 26 | </p> | |
| 27 | <p> | |
| 28 | The HMAC s tring is g enerated b y running an HMAC ha sh functio n on a pla in text st ring and t he applica tion's pri vate key. The plain text strin g that mus t be hashe d using HM AC is cons tructed as follows: | |
| 29 | <ul> | |
| 30 | <l i>HTTP Req uest Type< /li> | |
| 31 | <l i>Date</li > | |
| 32 | <l i>Content- MD5 (Optio nal)</li> | |
| 33 | <l i>Content Type (Not including boundary)< /li> | |
| 34 | <l i>URI</li> | |
| 35 | </ul> | |
| 36 | These valu es are sep arated by new line c haracters ("\n"). An example o f the plai n text str ing is bel ow: | |
| 37 | </p> | |
| 38 | <p class ="code"> | |
| 39 | POST\n06/0 3/2013 12: 13:56 EST\ niB94gawbw USiZy5Furu IOQ==\napp lication/x -www-form- urlencoded \n/direct/ messages/r estore/for mat/json | |
| 40 | </p> | |
| 41 | <p> | |
| 42 | The string above is hashed wit h the appl ication's private ke y using th e SHA-256 algorithm. A snippet of JavaSc ript code showing an example o f this is shown belo w: | |
| 43 | </p> | |
| 44 | <p class ="code"> | |
| 45 | var hashSt ring = Cry ptoJS.Hmac SHA256("PO ST\n06/03/ 2013 12:13 :56 EDT\ni B94gawbwUS iZy5FuruIO Q==\nappli cation/x-w ww-form-ur lencoded\n /direct/me ssages/res tore/forma t/json"," REDACTED "); | |
| 46 | <br/>var b ase64 = en code64(""+ hashString ); | |
| 47 | <br/>var a uthorizati on = "DAAS REDACTED :"+base64; | |
| 48 | </p> | |
| 49 | <p> | |
| 50 | In the exa mple above the Conte nt MD5 is provided b ut this is an option al field. If the Con tent MD5 h eader is n ot specifi ed then th e hash sho uld not ha ve the MD5 specified either. | |
| 51 | </p> | |
| 52 | <h3>Head ers</h3> | |
| 53 | <p> | |
| 54 | There are three head ers that m ust be sen t with eac h restore call and o ne optiona l header. These head ers are us ed in vali dating who the messa ge came fr om, who it is going to and the message i tself. | |
| 55 | </p> | |
| 56 | <div cla ss="column "> | |
| 57 | <div class ="left"> | |
| 58 | <u l> | |
| 59 | <li> Authorizat ion</li> | |
| 60 | <p> | |
| 61 | The fi rst requir ed header is the Aut horization header co vered in t he Authent ication se ction at t he top of this page. | |
| 62 | </p> | |
| 63 | <li> Date or X- Daas-Date< /li> | |
| 64 | <p> | |
| 65 | The se cond requi red header that must be includ ed is the Date heade r. Some br owsers wil l not let an applica tion speci fy the Dat e header p rogrammati cally, so in this ca se it is a lso accept able to us e the X-Da as-Date he ader as th e API will interpret them inte rchangeabl y. This he ader shoul d be popul ated with the curren t date and time, in any standa rd format (including time zone informati on if not time zone agnostic), when the POST reque st is subm itted. The value sup plied in t he Date he ader must match the value used in the cr eation of the hash s tring for the Author ization he ader. | |
| 66 | </p> | |
| 67 | </ ul> | |
| 68 | </div> | |
| 69 | <div class ="right"> | |
| 70 | <u l> | |
| 71 | <li> Content-Ty pe</li> | |
| 72 | <p> | |
| 73 | The fi nal requir ed header for POST r equests is the Conte nt-Type. T he Content -Type head er must ma tch the Co ntent-Type provided in the has h string f or the Aut horization header ex cept the h ash string does not include th e boundary parameter of the Co ntent-Type if there is one (i. e. applica tion/x-www -form-urle ncoded Con tent-Type) . | |
| 74 | </p> | |
| 75 | <li> Content-Md 5</li> | |
| 76 | <p> | |
| 77 | The op tional hea der is the Content-M d5 header. This head er should contain an MD5 hash of the ent ire POST b ody. If th is header is specifi ed then it must also be includ ed in the hash strin g for the Authorizat ion header . When pro vided, thi s serves a s an extra security precaution above and beyond TL S to ensur e the POST request s ent has no t been mod ified in t ransit. | |
| 78 | </p> | |
| 79 | </ ul> | |
| 80 | </div> | |
| 81 | </div> | |
| 82 | <h3>Argu ments</h3> | |
| 83 | <p> | |
| 84 | There are 3 argument s that can be sent t o the rest ore web se rvice. | |
| 85 | </p> | |
| 86 | <div cla ss="column "> | |
| 87 | <div class ="left"> | |
| 88 | <u l> | |
| 89 | <li> Mailbox</l i> | |
| 90 | <p> | |
| 91 | This i s a requir ed field w hich ident ifies whic h mailbox' s messages should be returned. This is t he local p ortion of the Direct address, i.e., test .user@<?ph p echo CLI NICAL_DOMA IN;?> is t he Direct address so that pass ed value y ou would t est.user. | |
| 92 | </p> | |
| 93 | </ ul> | |
| 94 | <u l> | |
| 95 | <li> Folder</li > | |
| 96 | <p> | |
| 97 | This i s an optio nal field which spec ifies whic h folder t he message will be r estored to . If this is left bl ank it is restored t o the fold er that it was origi nally arch ived from. This can be the ID of the cus tom folder or it can be the wo rd Inbox. | |
| 98 | </p> | |
| 99 | </ ul> | |
| 100 | </div> | |
| 101 | <div class ="right"> | |
| 102 | <u l> | |
| 103 | <li> ID</li> | |
| 104 | <p> | |
| 105 | This r equired fi eld is use d to speci fy which p articular message yo u would li ke to rest ore. | |
| 106 | </p> | |
| 107 | </ ul> | |
| 108 | </div> | |
| 109 | </div> | |
| 110 | <h3>Exam ple Respon se</h3> | |
| 111 | <ul> | |
| 112 | <li>Succes s</li> | |
| 113 | <u l> | |
| 114 | <li> HTTP-200, {"request_ id":"1","m essage":"e jaffee","i d":"20"}</ li> | |
| 115 | </ ul> | |
| 116 | <li>Error< /li> | |
| 117 | <u l> | |
| 118 | <li> HTTP-401, {"request_ id":"2","m essage": " Access Den ied. Authe ntication Failed."}< /li> | |
| 119 | <li> HTTP-403, {"request_ id":"3","m essage":"A ccess Deni ed. Use No t Authoriz ed."}</li> | |
| 120 | <li> HTTP-403, {"request_ id":"4","m essage":"A ccess Deni ed. User N ot Authori zed."}</li > | |
| 121 | <li> HTTP-422, {"request_ id":"5","m essage":"M essage not found"}</ li> | |
| 122 | <li> HTTP-422, {"request_ id":"6","f ields":["m ailbox"]," message":" 'Mailbox' is a requi red field. "}</li> | |
| 123 | <li> HTTP-422, {"request_ id":"7","m essage":"' Mailbox' c ontains in valid inpu t","fields ":["mailbo x"]}</li> | |
| 124 | </ ul> | |
| 125 | </ul> | |
| 126 | <h3>Samp le Code</h 3> | |
| 127 | <p> | |
| 128 | The restor e web serv ice is con structed i n the same manner th at the sen d web serv ice is. Pl ease click <a href=" /onboardin g/document ation/send _example"> here</a> t o be taken to some s ample code snippets for the se nd web ser vice and u se that as a basis f or creatin g the rest ore call. | |
| 129 | </p> | |
| 130 | </div> | |
| 131 | <?PHP $this->loa d->view('a pi/footer' ); ?> | |
| 132 | </di v> | |
| 133 | </ body> | |
| 134 | </html> |
Araxis Merge (but not the data content of this report) is Copyright © 1993-2016 Araxis Ltd (www.araxis.com). All rights reserved.