Examples added to readme

parent 75e08232
......@@ -14,13 +14,259 @@
Το πρόγραμμα δέχεται τις παρακάτω παραμέτρους:
```
Χρήση: index.php [--list] [--listshow] [--send <file>] [--show <hashid>] [--get <hashid>] [--save <hashid>]
list: λίστα hashids των εγγράφων
listshow: λίστα αρχείων
Χρήση: index.php [-v] [--list] [--listshow] [-i|-o] [--send <file>] [--attach <file>] [--show <hashid>] [--get <hashid>] [--save <hashid>]
v: παραγωγή μηνυμάτων παρακολούθησης εκτέλεσης
list: λίστα hashids των εγγράφων (των τελευταίων 5 ημερών)
listshow: λίστα αρχείων (των τελευταίων 5 ημερών)
i: να συμπεριληφθούν μόνο τα εισερχόμενα στη λίστα αρχείων
ο: να συμπεριληφθούν μόνο τα εξερχόμενα στη λίστα αρχείων
send <file>: καταχώρηση πρωτοκόλλου με αποστολή του αρχείου file
attach <file>: επισύναψη αρχείου στην καταχώρηση (πολλαπλό)
show <hash>: αναλυτικές πληροφορίες αρχείου με δεδομένο hashid
get <hash>: λήψη αρχείου με δεδομένο hashid
save <hash>: λήψη και αποθήκευση αρχείου με δεδομένο hashid
στον τρέχοντα φάκελο και με το όνομα αρχείου που επιστρέφεται
```
## Παραδείγματα κλήσης
### Λίστα εγγράφων
```sh
$ php index.php --list
Ανάκτηση API key...
Το API key είναι: eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiIxMDAwMDAwIn0.h_vUGpeFjhajdlMFAwZVTnuNPwVXxHfc6ehWnpLHvik
Ανάκτηση λίστας εγγράφων...
Λίστα εγγράφων:
Bl5BEZPKGztl2lcmtEWMgQ%3D%3D
r%2BhOqWinF8U%2FPKM6RDn45g%3D%3D
ai2nYtQPsm5iWacd1NEEYw%3D%3D
69t%2FYlgsEJjQMiWkPUFpFQ%3D%3D
XJL2Whs6%2FBsu6ObQ%2FpeMlw%3D%3D
QiQ8VaRYeItETkqP%2FKjTVQ%3D%3D
ELTKEUX%2B0FLyivlIm%2Bm0uw%3D%3D
OrDAz8L9tF0AGSGutQ0Hxw%3D%3D
lmyplemnNoaMR0W6TU0uqg%3D%3D
%2F%2FvoXi7pZMVHdFvVlTTLGQ%3D%3D
GHotM8CWL%2FvGPjabwzHhqg%3D%3D
NU6CEaLymbOjqzla1iSuyQ%3D%3D
22UMz%2B55qhqJhy2AL0Ihtg%3D%3D
vhX1LPAxgI8VTHpXrXzNIQ%3D%3D
tbAP3jdzbrj%2BtB9prn1s2w%3D%3D
1Lph6VjgxqRjVhiyMNNgTg%3D%3D
L3Wwrt54uCCyAqoCN51enA%3D%3D
HN9eLwiPjsKncOxfWsFlKw%3D%3D
RLjZIIroC0WTWARa8iPxjw%3D%3D
IFFnDJWBuWhtpQhvlzPyMQ%3D%3D
K7ga1NQ2wONXb3364Q9Elg%3D%3D
OblOuYKCQEdnwH1PFBstxA%3D%3D
rSOTUDYNkHWBDktlAP31Hg%3D%3D
Done.
```
**Παράδειγμα με verbose output**
```sh
$ php index.php --list -v
Ανάκτηση API key...
getApiKey :: payload: {"username":"test","password":"123456"}
* Trying 195.251.16.162...
* Connected to protocoltest.minedu.gov.gr (195.251.16.162) port 443 (#0)
* ALPN, offering http/1.1
* Cipher selection: ALL:!EXPORT:!EXPORT40:!EXPORT56:!aNULL:!LOW:!RC4:@STRENGTH
* successfully set certificate verify locations:
* CAfile: /etc/ssl/certs/ca-certificates.crt
CApath: /etc/ssl/certs
* SSL connection using TLSv1.2 / ECDHE-RSA-AES256-GCM-SHA384
* ALPN, server did not agree to a protocol
* Server certificate:
* subject: C=GR; ST=Athens; L=Maroussi; O=Greek Ministry of Education; OU=IT; CN=protocoltest.minedu.gov.gr
* start date: Aug 5 00:00:00 2016 GMT
* expire date: Aug 14 12:00:00 2019 GMT
* subjectAltName: protocoltest.minedu.gov.gr matched
* issuer: C=NL; ST=Noord-Holland; L=Amsterdam; O=TERENA; CN=TERENA SSL CA 3
* SSL certificate verify ok.
> PUT /openpapyros/api/pauthenticate/pauth HTTP/1.1
Host: protocoltest.minedu.gov.gr
User-Agent: OSTEAM barebone php client
Content-Type: application/json
Accept: application/json
Content-Length: 39
* upload completely sent off: 39 out of 39 bytes
< HTTP/1.1 200 OK
< Date: Fri, 23 Dec 2016 10:33:51 GMT
< Server: Apache
< X-Powered-By: Modus/Undertow/1
< Content-Type: application/json
< Content-Length: 101
< Vary: Accept-Encoding
<
* Connection #0 to host protocoltest.minedu.gov.gr left intact
Το API key είναι: eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiIxMDAwMDAwIn0.X6fRd7StTnSIq11S7IpjaMSTP3540ypEfXV6sJRWujk
Ανάκτηση λίστας εγγράφων...
searchDocuments :: payload: {"senderId":100000001,"docType":null,"startDate":"2016-12-18T00:00:00+02:00","endDate":"2016-12-23T12:33:52+02:00"}
* Hostname protocoltest.minedu.gov.gr was found in DNS cache
* Trying 195.251.16.162...
* Connected to protocoltest.minedu.gov.gr (195.251.16.162) port 443 (#0)
* ALPN, offering http/1.1
* Cipher selection: ALL:!EXPORT:!EXPORT40:!EXPORT56:!aNULL:!LOW:!RC4:@STRENGTH
* successfully set certificate verify locations:
* CAfile: /etc/ssl/certs/ca-certificates.crt
CApath: /etc/ssl/certs
* SSL connection using TLSv1.2 / ECDHE-RSA-AES256-GCM-SHA384
* ALPN, server did not agree to a protocol
* Server certificate:
* subject: C=GR; ST=Athens; L=Maroussi; O=Greek Ministry of Education; OU=IT; CN=protocoltest.minedu.gov.gr
* start date: Aug 5 00:00:00 2016 GMT
* expire date: Aug 14 12:00:00 2019 GMT
* subjectAltName: protocoltest.minedu.gov.gr matched
* issuer: C=NL; ST=Noord-Holland; L=Amsterdam; O=TERENA; CN=TERENA SSL CA 3
* SSL certificate verify ok.
> POST /openpapyros/api/search/documents HTTP/1.1
Host: protocoltest.minedu.gov.gr
User-Agent: OSTEAM barebone php client
api_key: eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiIxMDAwMDAwIn0.X6fRd7StTnSIq11S7IpjaMSTP3540ypEfXV6sJRWujk
Content-Type: application/json
Accept: application/json
Content-Length: 115
* upload completely sent off: 115 out of 115 bytes
< HTTP/1.1 200 OK
< Date: Fri, 23 Dec 2016 10:33:52 GMT
< Server: Apache
< X-Powered-By: Modus/Undertow/1
< Content-Type: application/json
< Content-Length: 740
< Vary: Accept-Encoding
<
* Connection #0 to host protocoltest.minedu.gov.gr left intact
Λίστα εγγράφων:
Bl5BEZPKGztl2lcmtEWMgQ%3D%3D
r%2BhOqWinF8U%2FPKM6RDn45g%3D%3D
ai2nYtQPsm5iWacd1NEEYw%3D%3D
69t%2FYlgsEJjQMiWkPUFpFQ%3D%3D
XJL2Whs6%2FBsu6ObQ%2FpeMlw%3D%3D
QiQ8VaRYeItETkqP%2FKjTVQ%3D%3D
ELTKEUX%2B0FLyivlIm%2Bm0uw%3D%3D
OrDAz8L9tF0AGSGutQ0Hxw%3D%3D
lmyplemnNoaMR0W6TU0uqg%3D%3D
%2F%2FvoXi7pZMVHdFvVlTTLGQ%3D%3D
GHotM8CWL%2FvGPjabwzHhqg%3D%3D
NU6CEaLymbOjqzla1iSuyQ%3D%3D
22UMz%2B55qhqJhy2AL0Ihtg%3D%3D
vhX1LPAxgI8VTHpXrXzNIQ%3D%3D
tbAP3jdzbrj%2BtB9prn1s2w%3D%3D
1Lph6VjgxqRjVhiyMNNgTg%3D%3D
L3Wwrt54uCCyAqoCN51enA%3D%3D
HN9eLwiPjsKncOxfWsFlKw%3D%3D
RLjZIIroC0WTWARa8iPxjw%3D%3D
IFFnDJWBuWhtpQhvlzPyMQ%3D%3D
K7ga1NQ2wONXb3364Q9Elg%3D%3D
OblOuYKCQEdnwH1PFBstxA%3D%3D
rSOTUDYNkHWBDktlAP31Hg%3D%3D
Done.
```
### Πρωτοκόλληση εγγράφου
**Με συνημμένο αρχείο**
```sh
$ php index.php --send /tmp/test-file2.pdf --attach /tmp/test-file.pdf
Ανάκτηση API key...
Το API key είναι: eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiIxMDAwMDAwIn0.-5lgafnO-ACRSchNQQhUpx8RfuZnGQtvF9-eIl9EJsY
Αποστολή εγγράφου...
Έλεγχος για το αρχείο /tmp/test-file2.pdf... OK
Έλεγχος για το συνημμένο αρχείο /tmp/test-file.pdf... OK
Η αποστολή ολοκληρώθηκε με ΑΡ.Π.: 180042
Αναλυτικά: Array
(
[docId] => rSOTUDYNkHWBDktlAP31Hg%3D%3D
[protocolYear] => 2016
[protocolDate] => 23/12/2016
[protocolNumber] => 180042
[attachments] => Array
(
[0] => Array
(
[docId] => 7Kv7cp7J5fQRXyw7R1mEGQ%3D%3D
[description] =>
)
)
)
Done.
```
### Λεπτομέρειες πρωτοκόλλου
```sh
$ php index.php --show "rSOTUDYNkHWBDktlAP31Hg%3D%3D"
Ανάκτηση API key...
Το API key είναι: eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiIxMDAwMDAwIn0.UD9kmeoxUiytUiKBuq6ckeRkwlGoBmwLETlpNdtbX7Q
Λεπτομέρειες εγγράφου:
Array
(
[id] => rSOTUDYNkHWBDktlAP31Hg%3D%3D
[protocolNumber] => 180042
[protocolDate] => 23/12/2016
[docType] => 7
[sender] => 100000001
[senderProtocol] =>
[senderDateProtocol] =>
[docCategory] => 20
[theme] => ΔΟΚΙΜΗ: Αυτοματοποιημένο κείμενο της 2016-12-23T12:27:06+02:00
[ada] =>
[attachedDocsDescr] => ΔΟΚΙΜΗ: Αυτοματοποιημένο κείμενο περιγραφής 20161223121227
[director] => ΔΟΚΙΜΗ: Αυτοματοποιημένο κείμενο περιγραφής 20161223121227
[attachedId] => Array
(
[0] => 7Kv7cp7J5fQRXyw7R1mEGQ%3D%3D
)
)
Done.
```
### Πληροφορίες αρχείου
```sh
$ php index.php --get "rSOTUDYNkHWBDktlAP31Hg%3D%3D"
Ανάκτηση API key...
Το API key είναι: eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiIxMDAwMDAwIn0.S70EW5ruMkAzxg4QaY0izZj0xSF_jeRrTvMiOf7DC10
Λεπτομέρειες εγγράφου:
Array
(
[document] => Array
(
[base64] => go=
)
[fileName] => test-file2.pdf
[description] => ΕΙΣ - 180042 - 2016
)
Done.
```
### Λήψη αρχείου
```sh
$ php index.php --save "7Kv7cp7J5fQRXyw7R1mEGQ%3D%3D"
Ανάκτηση API key...
Το API key είναι: eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiIxMDAwMDAwIn0.WLTS9UxlPDZw-1WsjWush7HXzYWRjazJMEYR8Q58mjo
Λεπτομέρειες αποθήκευσης εγγράφου:
Array
(
[file_name] => test-file.pdf
[description] => ΔΟΚΙΜΗ: Αποστολή συνημμένου δοκιμαστικού αρχείου /tmp/test-file.pdf
[save] => Αποθηκεύτηκε
)
Done.
```
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment