-
Notifications
You must be signed in to change notification settings - Fork 6
/
readme.txt
134 lines (103 loc) · 5.15 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/* Copyright (c) 2011 Zuora, Inc.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to use copy,
* modify, merge, publish the Software and to distribute, and sublicense copies of
* the Software, provided no fee is charged for the Software. In addition the
* rights specified above are conditioned upon the following:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* Zuora, Inc. or any other trademarks of Zuora, Inc. may not be used to endorse
* or promote products derived from this Software without specific prior written
* permission from Zuora, Inc.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
* ZUORA, INC. BE LIABLE FOR ANY DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
Zuora PHP Toolkit
INTRODUCTION
------------
The PHP toolkit provides useful utilities for Zuora developers to introspect, pull data from and develop against the Zuora APIs.
REQUIREMENTS
------------
This utility requires PHP with add-ons. The following are required to run this package.
PHP 5.2.9+
-SOAP
-OpenSSL
-XML-RPC
-XSL
CONTENTS
--------
call-lib.php - re-usable library of Zuora API calls
index.php - API utility front page
queryMore.xml - queryMore() template
readme.txt -this file
subscribe.xml - subscribe() template, latest version
subscribeV9.xml- subscribe() template, version 9
subscribeV11.xml - subscribe() template, version 11
subscribeWithExistingAccount.xml - subscribeWithExistingAccount() template, latest version
subscribeWithExistingAccountV9.xml- subscribe() template, version 9
zuora-19.0-sandbox-AllOptions.wsdl - v19 WSDL, sandbox
zuora-25.0-sandbox-AllOptions.wsdl - v25 WSDL, sandbox
zuora-27.0-sandbox-AllOptions.wsdl - v27 WSDL, sandbox
loader/index.php - Loader utility front page
loader/call.php - Loader command line code
loader/settings.php - Loader common settings file
INSTALLATION INSTRUCTIONS
-------------------------
The following instructions assume that you're going to use Xampp (http://www.apachefriends.org/en/xampp.html) on the localhost as the web server.
a) Make sure no other application is running on port 80. You can verify this by running "netstat -a -n -o" on the command prompt. Terminate the offending app, if running on port 80.
b) Install Xampp for Windows using default path.
c) Run the Xampp config tool.
d) Click on Port Check button on the Xamp control panel. Make sure Port 80 is available.
e) In the Xampp control panel start Apache server.
f) In the Xampp directory, extract the zip file (Zuora source) under a folder named api-util.
g) Make sure Apache is running.
h) In a web browser type http://localhost/api-util/. This should load up the API Utility for Zuora. http://localhost/api-util/loader/ should load the API Loader.
POTENTIAL INSTALLATION ISSUES
-----------------------------
With the latest XAMPP (version 1.7.4), there are a couple of additional things that need to be done in the php.ini file located in the \xampp\php\ folder:
-In the "Error Handling and Logging" section, error_reporting value needs to be changed to (preventing run time errors from displaying with the application):
error_reporting = E_ALL & ~E_NOTICE
-In the "Windows Extensions" section, some of the required extensions are commented out, specifically:
extension=php_openssl.dll
extension=php_soap.dll
extension=php_xmlrpc.dll
extension=php_xsl.dll
Also, it is possible that your enterprise is using a proxy, which will need to be configured, otherwise you'll get an "Unknown Host" error. To set up a proxy with XAMPP (instructions taken from http://stackoverflow.com/questions/724599/setting-up-an-apache-proxy-with-authentication, adapted by Alexander Grinchik):
-Uncomment the following lines in httpd.conf file (found in xampp/apache/conf/):
LoadModule proxy_module modules/mod_proxy.so
LoadModule proxy_http_module modules/mod_proxy_http.so
-Include the following line in httpd.conf file:
# Implements a proxy/gateway for Apache.
Include "conf/extra/httpd-proxy.conf"
-Create a new file in xampp/apache/conf/extra/ directory called httpd-proxy.conf with the following contents:
#
# Implements a proxy/gateway for Apache.
# # Required modules: mod_proxy, mod_proxy_http
#
<IfModule proxy_module>
<IfModule proxy_http_module>
#
# Reverse Proxy
#
ProxyRequests On
ProxyVia On
<Proxy *>
Order deny,allow
Allow from all
</Proxy>
</IfModule>
</IfModule>
DOCUMENTATION & SUPPORT
-----------------------
API Documentation is available at http://developer.zuora.com