| 1 | = [wiki:DeployerGuide Przewodnik wdrożeniowca] > Tytuł - identyczny z linkiem z działu = |
| 2 | |
| 3 | System eDokumenty udostępnia API (Application Programming Interface) dzięki któremu jesteśmy w stanie przeprowadzać podstawowe czynności bez konieczności logowania do systemu. |
| 4 | |
| 5 | Usługa jest zabezpieczona rozszerzeniem WSSecurity protokołu SOAP i wymaga |
| 6 | podania w nagłówkach wywołania XML nazwy użytkownika i hasła. |
| 7 | |
| 8 | Hasło i użytkownik to specjalne dane, które należy wprowadzić do pliku config.inc pod kluczami |
| 9 | |
| 10 | {{{ |
| 11 | define('EDOK_API_LOGIN', 'edok_api_user'); |
| 12 | define('EDOK_API_PASSWORD', 'edok_api_pass'); |
| 13 | }}} |
| 14 | |
| 15 | wartości stałych w powyższym przykładzie są tylko danymi prezentacyjnymi i nie powinno się ich używać nigdzie indziej. |
| 16 | |
| 17 | Stałe te mogą mieć dowolne wartości ważne jednak aby te same wartości podać przy wywołaniu usługi SOAP. Nagłówek SOAP powinien wyglądać |
| 18 | {{{ |
| 19 | <wsse:Security xmlns:wsse=”http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd” soapenv:mustUnderstand=”0”> |
| 20 | <wsse:UsernameToken> |
| 21 | <wsse:Username Type=”http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#UsernameToken”>edok_api_user</wsse:Username> |
| 22 | <wsse:Password Type=”http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText”>edok_api_pass</wsse:Password> |
| 23 | </wsse:UsernameToken> |
| 24 | </wsse :Security> |
| 25 | }}} |
| 26 | |
| 27 | Dodatkowo w nagłówku należy przesłać wartość jednostki |
| 28 | |
| 29 | {{{ |
| 30 | $header = new SoapHeader('eDokumentyAPI', 'entity_symbol', 'symbol jednostki'); |
| 31 | }}} |
| 32 | |
| 33 | Usługa jest dostępna pod adresem: |
| 34 | |
| 35 | http://{host}:{port}/apps/edokumenty/classes/eDokumentyApi/EDokApiServer.php |
| 36 | |
| 37 | Opcjonalnie od wersji 0.9.8 usługa jest dostępna pod skróconym adresem: |
| 38 | |
| 39 | http://{host}:{port}/eDokumentyApi.php |
| 40 | |
| 41 | Wartość {host} oraz {port} należy zamienić odpowiednimi wartościami zgodnymi z konfiguracją serwera instalacyjnego systemu eDokumenty. |
| 42 | |