Peter M. Groen / knowledgetree

Commit ce4efb7f14c6d3db099056e212baf4e0f2f029b2

Authored by conradverm
1 parent 707ed207

KTS-1694 

"SOAP Webservice Implementation"
Added.

Reviewed By: Kevin Fourie

git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@6465 c91229c3-7414-0410-bfa2-8a42b809f60b
Inline Side-by-side
Showing 1 changed file with 73 additions and 0 deletions
ktwebservice/docs/INSTALL.txt 0 → 100644
  View file @ce4efb7
  1 +KnowledgeTree WebServices
  2 +=========================
  3 +
  4 +Dependencies
  5 +------------
  6 +
  7 +This is dependant on:
  8 +1) KTAPI
  9 +2) libcurl
  10 +3) PEAR:SOAP
  11 +
  12 +
  13 +Installation
  14 +------------
  15 +
  16 +Assuming that <ktroot> denotes the base directory where KnowledgeTree is installed,
  17 +the following structure is expected:
  18 +
  19 +<ktroot>/ktapi - location of KT API
  20 +<ktroot>/ktwebservice - location of KT Web Service
  21 +<ktroot>/var/uploads - location of uploads
  22 +
  23 +Installing libcurl
  24 +------------------
  25 +
  26 +Curl and libcurl are available from http://curl.haxx.se/ and http://curl.haxx.se/libcurl/ respectively.
  27 +
  28 +You may need to edit your php.ini file. You may require to add something like:
  29 +
  30 +extension=php_curl.dll
  31 +
  32 +
  33 +Installing PEAR::SOAP
  34 +---------------------
  35 +
  36 +We assume PEAR::SOAP will be available in the <ktroot>/thirdparty/pear/SOAP directory.
  37 +
  38 +Please review http://pear.php.net/ on the installation procedure if a newer version is required.
  39 +
  40 +Configuration
  41 +-------------
  42 +
  43 +The following can be configured in the configuration file (config.ini):
  44 +
  45 +[webservices]
  46 +
  47 +; the upload directory
  48 +uploadDirectory = ${varDirectory}/uploads
  49 +
  50 +; this is the location for downloads from calls to web services
  51 +downloadUrl = ${rootUrl}/ktwebservice/download.php
  52 +
  53 +; Files must be uploaded before they can be interacted with
  54 +uploadExpiry = 30
  55 +
  56 +; The Web Service download request just makes a file temporarily available. If it is not downloaded in the time frame below, it will not be available.
  57 +downloadExpiry = 30
  58 +
  59 +; It is recommended that the administrator add some random text here. This will prevent different installations generating hashes in the same manner.
  60 +randomKeyText = bkdfjhg23yskjdhf2iu
  61 +
  62 +Using Web Services
  63 +------------------
  64 +
  65 +The WSDL for the KnowledgeTree Web Service can be referenced as follows:
  66 +
  67 +http://ktdms.trunk/ktwebservice/?wsdl
  68 +
  69 +or
  70 +
  71 +http://ktdms.trunk/ktwebservice/webservice.php?wsdl
  72 +
  73 +The KTWS API package provides an object oriented wrapping of the web service functionality.
... ...