| Local Listener / Local HTTP Users Configuration | |
The HTTP Server allows users to log into the Cleo Harmony or Cleo VLTrader application and store and retrieve files using standard HTTP. A full description of the HTTP protocol can be found in the RFC 2616 specification.
The following HTTP methods and parameters are accepted and processed by the Cleo Harmony or Cleo VLTrader HTTP server (these methods and parameters are also captured in the preconfigured host, Generic Cleo HTTPs).
| Purpose | HTTP Method | Parameters | Comments |
|---|---|---|---|
| Login | POST | request=connect0 | Login can also occur via other requests, but if using request=send and 401 Unauthorized is bounced back by Cleo Harmony or Cleo VLTrader, file content will be sent more than once. |
| Send Inbound |
POST | request=send | Uploading inbound payload |
| directory= | Optional parameter; defaults to inbox/ | ||
| filename= | Optional parameter; name of file being uploaded | ||
| Outbound Directory Listing |
POST | request=list | Listing available outbound payload |
| directory= | Optional parameter; defaults to outbox/payload/ | ||
| Receive Outbound |
POST | request=receive | Downloading outbound payload |
| directory= | Optional parameter; defaults to outbox/payload/ | ||
| filename= | Name of file being requested for download | ||
| Delete Outbound |
POST | request=delete | Deleting outbound payload |
| directory= | Optional parameter; defaults to outbox/payload | ||
| filename= | Name of file being deleted |
The Cleo Harmony and Cleo VLTrader applications also support HTTP PUT, GET, and DELETE methods for sending payload, receiving directory listings and payload, and deleting payload respectively, but the POST methods are recommended. Following are captures of example HTTP requests and responses demonstrating the above methods. While the examples below only show parameters on the POST line, the Cleo Harmony and Cleo VLTrader applications do accept requests using the application/x-www-form-urlencoded and multipart/form-data Content-types.
Client initial connect request without authorization
POST /server?request=connect HTTP/1.1 Host: test.cleo.com:5080 Connection: Keep-Alive, TE TE: trailers, deflate, gzip, compress User-Agent: RPT-HTTPClient/0.3-3I (Windows XP) Content-length: 0
Cleo Harmony or Cleo VLTrader application response (unauthorized; both basic and digest Authentication is enabled)
HTTP/1.1 401 Unauthorized Server: Cleo VLTrader/3.5 (Windows 2000) Date: Tue, 22 May 2007 17:04:13 GMT WWW-Authenticate: Basic realm="Cleo VLTrader" WWW-Authenticate: Digest realm="Cleo VLTrader",domain="/server",qop="auth",nonce="0qenmpn44",opaque="4b4c37373332" Connection: close Content-Type: text/html Content-Length: 80 <html><head><title> Unauthorized</title></head><body> Unauthorized</body></html>
Client connect request with digest authorization
POST /server?request=connect HTTP/1.1 Host: test.cleo.com:5080 Connection: TE TE: trailers, deflate, gzip, compressUser-Agent: RPT-HTTPClient/0.3-3I (Windows XP) Authorization: Digest realm="Cleo VLTrader",username="cleo",uri="/server%3Frequest=connect",nonce="0qenmpn44",response="b4f7542bdedce937de6aa93078fcdf17",opaque="4b4c37373332",cnonce="f5f20437b69ca661e4aedfedb54f5c32",qop="auth",nc="00000001" Content-length: 0
Cleo Harmony or Cleo VLTrader application response (authentication successful)
HTTP/1.1 200 OK Server: Cleo VLTrader/3.5 (Windows 2000) Date: Tue, 22 May 2007 17:04:18 GMT Content-Length: 0 Set-cookie: jSessionId=3513ld61kg8bt; path=/ Connection: keep-alive
Client send (upload) request
POST /server?request=send&directory=inbox%2F HTTP/1.1 Host: test.cleo.com:5080 Connection: TE TE: trailers, deflate, gzip, compress User-Agent: RPT-HTTPClient/0.3-3I (Windows XP) Cookie: jSessionId=3513ld61kg8bt Cookie2: $Version="1" Authorization: Digest realm="Cleo VLTrader",username="cleo",uri=... Content-type: application/octet-stream; name="test.edi" Content-length: 1533 ...payload...
Cleo Harmony or Cleo VLTrader application response (send successful)
HTTP/1.1 200 OK Server: Cleo VLTrader/3.5 (Windows 2000) Date: Tue, 22 May 2007 17:19:59 GMT Content-Type: text/html Content-Length: 84 Connection: keep-alive <html><head><title>OK</title></head><body>File successfully uploaded.</body></html>
Client list request
POST /server?request=list&directory=outbox%2Fpayload%2F HTTP/1.1 Host: test.cleo.com:5080 Connection: TE TE: trailers, deflate, gzip, compress User-Agent: RPT-HTTPClient/0.3-3I (Windows XP) Cookie: jSessionId=3513ld61kg8bt Cookie2: $Version="1" Authorization: Digest realm="Cleo VLTrader",username="cleo",uri=... Content-length: 0
Cleo Harmony or Cleo VLTrader application response (listing successful)
HTTP/1.1 200 OK Server: Cleo VLTrader/3.5 (Windows 2000) Date: Tue, 22 May 2007 17:04:18 GMT Content-Type: text/html Content-Length: 402 Connection: keep-alive <head><title>'cleo' mailbox</title></head><body><pre><H2>Download</H2>Server directory: outbox/payload/<hr> 2007/05/03 08:43:17 1.497kB <A HREF="/server/outbox/payload/test.edi" >test.edi</A><br> 2007/05/22 08:32:46 4.491kB <A HREF="/server/outbox/payload/test2.edi" >test2.edi</A><br> 2007/05/22 08:33:28 28.444kB <A HREF="/server/outbox/payload/test3.edi" >test3.edi</A><br><hr></pre></body>
Client receive (download) request
POST /server?request=receive&directory=outbox%2Fpayload&filename=test.edi HTTP/1.1 Host: test.cleo.com:5080 Connection: TE TE: trailers, deflate, gzip, compress User-Agent: RPT-HTTPClient/0.3-3I (Windows XP) Cookie: jSessionId=3513ld61kg8bt Cookie2: $Version="1" Authorization: Digest realm="Cleo VLTrader",username="cleo",uri=... Content-length: 0
Cleo Harmony or Cleo VLTrader application response (receive successful)
HTTP/1.1 200 OK Server: Cleo VLTrader/3.5 (Windows 2000) Date: Tue, 22 May 2007 17:25:57 GMT Content-Description: test.edi Content-Disposition: attachment; filename="test.edi" Transfer-Encoding: chunked Content-Type: application/edi-x12; name="test.edi" Connection: keep-alive ...chunked payload...
Client delete request
POST /server?request=delete&directory=outbox%2Fpayload&filename=test.edi HTTP/1.1 Host: test.cleo.com:5080 Connection: TE TE: trailers, deflate, gzip, compress User-Agent: RPT-HTTPClient/0.3-3I (Windows XP) Cookie: jSessionId=3513ld61kg8bt Cookie2: $Version="1" Authorization: Digest realm="Cleo VLTrader",username="cleo",uri=... Content-length: 0
Cleo Harmony or Cleo VLTrader application response (delete successful)
HTTP/1.1 200 OK Server: Cleo VLTrader/3.5 (Windows 2000) Date: Tue, 22 May 2007 17:25:58 GMT Content-Length: 0 Connection: keep-alive
A web browser can also be used by a trading partner to manually trade with VerasLex's HTTP server. A trading partner would use the Cleo Harmony or Cleo VLTrader address and HTTP server resource path to start (for example, https://test.cleo.com:6080/server):
After logging in, a simple web page is displayed to allow uploading and downloading of files.