README.md 12.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Βιβλιοθήκη και πρόγραμμα κατανάλωσης 
====================================

# Οδηγίες 

Αντιγράψτε το αρχείο `settings.php.dist` σε ένα νέο αρχείο `settings.php` και
τροποποιήστε αναλόγως, για παράδειγμα εισάγοντας το όνομα χρήστη που σας έχει 
αποδοθεί. 

# Πρόγραμμα επίδειξης 

Για την επίδειξη των διαθέσιμων λειτουργιών έχει αναπτυχθεί πρόγραμμα 
[index.php](index.php) που μπορείτε να εκτελέσετε από τη γραμμή εντολών.
Το πρόγραμμα δέχεται τις παρακάτω παραμέτρους: 

```
17 18 19 20 21 22
Χρήση: index.php [-v] [--list] [--listshow] [-i|-o] [--send <file>] [--attach <file>] [--show <hashid>] [--get <hashid>] [--save <hashid>]
            v: παραγωγή μηνυμάτων παρακολούθησης εκτέλεσης
         list: λίστα hashids των εγγράφων (των τελευταίων 5 ημερών)
     listshow: λίστα αρχείων (των τελευταίων 5 ημερών)
            i: να συμπεριληφθούν μόνο τα εισερχόμενα στη λίστα αρχείων
            ο: να συμπεριληφθούν μόνο τα εξερχόμενα στη λίστα αρχείων
23
  send <file>: καταχώρηση πρωτοκόλλου με αποστολή του αρχείου file
24
attach <file>: επισύναψη αρχείου στην καταχώρηση (πολλαπλό)
25 26 27 28 29 30
  show <hash>: αναλυτικές πληροφορίες αρχείου με δεδομένο hashid
   get <hash>: λήψη  αρχείου με δεδομένο hashid
  save <hash>: λήψη και αποθήκευση αρχείου με δεδομένο hashid
               στον τρέχοντα φάκελο και με το όνομα αρχείου που επιστρέφεται
```

31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
Το πρόγραμμα χρησιμοποιεί τη δοκιμαστική βιβλιοθήκη επίδειξης που αποτελείται 
από δύο τμήματα [Gr\Gov\Minedu\Osteam\App](src/App.php) και 
[Gr\Gov\Minedu\Osteam\Client](src/Client.php) 

# Βιβλιοθήκη 

>>>
Η δοκιμαστική βιβλιοθήκη επίδειξης περιλαμβάνει παραδείγματα αξιοποίησης όλων 
των REST API κλήσεων του [minedu OpenApi της ΠΑΠΥΡΟΣ](https://git.minedu.gov.gr/itminedu/minedu-OpenApi-PapyrosDrivers) 
σε καμία περίπτωση όμως δεν αποτελεί πλήρως λειτουργική βιβλιοθήκη ή πλήρως
λειτουργική εφαρμογή.
>>>

## Gr\Gov\Minedu\Osteam\App 

46 47 48
Η κλάση [Gr\Gov\Minedu\Osteam\App](src/App.php) παρέχει μεθόδους διευκόλυνσης 
για τον προγραμματιστή ώστε να μπορεί εύκολα να καταναλώσει λειτουργίες που
αφορούν την πρωτοκόλληση εγγράφων. Οι βασικές λειτουργίες είναι: 
49

50 51 52 53 54 55
* getApiKey()
* searchDocuments($sender_id = null, $date_from = null, $date_to = null, $doc_type = null, $apikey = null)
* getDocData($hashid, $apikey = null)
* postProtocol($submission_data, $apikey = null)
* getPdf($hashid, $apikey = null)
* savePdf($hashid, $apikey = null)
56

57
**Τεκμηρίωση παρέχεται εντός του [Gr\Gov\Minedu\Osteam\App](src/App.php)**
58 59 60

## Gr\Gov\Minedu\Osteam\Client 

61
Η κλάση [Gr\Gov\Minedu\Osteam\Client](src/Client.php) καταναλώνει λειτουργίες του 
62
[minedu OpenApi της ΠΑΠΥΡΟΣ](https://git.minedu.gov.gr/itminedu/minedu-OpenApi-PapyrosDrivers) 
63 64 65
αξιοποιώντας τη βιβλιοθήκη CURL. Παρέχει μεθόδους αφαίρεσης για κατανάλωση των
λειτουργιών που αφορούν την πρωτοκόλληση εγγράφων καθώς και βασικές μεθόδους
κλήσης GET, PUT, POST. Οι βασικές λειτουργίες είναι: 
66

67 68 69 70 71 72 73 74
* pauth($payload)
* searchDocuments($payload, $apikey)
* getDocData($hashid, $apikey)
* getPdf($hashid, $apikey)
* postProtocol($payload, $apikey)
* _put($uri, $payload, $headers = [])_
* _post($uri, $payload, $headers = [])_
* _get($uri, $params = [], $headers = [])_
75

76 77
## Παραδείγματα κλήσης

78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
### Πρωτοκόλληση εγγράφου 

**Με συνημμένο αρχείο**

```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.
```

111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
### Λίστα εγγράφων 

```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 --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.
```