|
72
|
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" |
|
|
2 |
"http://www.w3.org/TR/html4/strict.dtd"> |
|
|
3 |
<html xmlns="http://www.w3.org/1999/xhtml" |
|
|
4 |
xmlns:xi="http://www.w3.org/2001/XInclude" |
|
|
5 |
xmlns:py="http://genshi.edgewall.org/"> |
|
|
6 |
<xi:include href="layout.tmpl" /> |
|
|
7 |
<head> |
|
|
8 |
<title>api docs new</title> |
|
|
9 |
</head> |
|
|
10 |
<body> |
|
|
11 |
<title>geplante API Dokumentation</title> |
|
|
12 |
<div class="item"> |
|
|
13 |
<p> |
|
|
14 |
|
|
|
15 |
</p> |
|
|
16 |
<ol> |
|
|
17 |
<li value="1">1. <a href="#api-intro">Einführung</a></li> |
|
|
18 |
<li value="2">2. |
|
|
19 |
<a href="#api-interfaces">Interfaces</a> |
|
|
20 |
<ol> |
|
|
21 |
<li value="2.1">2.1 <a href="#interface-xmlrpc">XML-RPC</a></li> |
|
73
|
22 |
<li value="2.1">2.1 <a href="#interface-soap">SOAP</a></li> |
|
72
|
23 |
<li value="2.2">2.2 <a href="#interface-xml">XML</a></li> |
|
|
24 |
<li value="2.3">2.3 <a href="#interface-json">JSON</a></li> |
|
|
25 |
<li value="2.4">2.4 <a href="#interface-jsonp">JSONP</a></li> |
|
|
26 |
<li value="2.5">2.5 <a href="#interface-php">PHP</a></li> |
|
|
27 |
</ol> |
|
|
28 |
</li> |
|
|
29 |
<li value="3">3. |
|
73
|
30 |
<a href="#api-methods">Methoden</a> |
|
|
31 |
<ol> |
|
|
32 |
<li py:for="(key,method) in enumerate(new)" value="3.${key+1}">3.${key+1} <a href="#method-${method.name}">${method.title}</a></li> |
|
|
33 |
</ol> |
|
72
|
34 |
</li> |
|
73
|
35 |
|
|
72
|
36 |
</ol> |
|
|
37 |
</div> |
|
|
38 |
<div class="item" id="api-intro"> |
|
|
39 |
<h3>Einführung</h3> |
|
|
40 |
<p> |
|
73
|
41 |
Die Iro API enthält Funktion, die für den Massenversand nützlich sind. |
|
72
|
42 |
</p> |
|
|
43 |
</div> |
|
|
44 |
<div class="item" id="api-interfaces"> |
|
|
45 |
<h3>Interfaces</h3> |
|
|
46 |
<p> |
|
73
|
47 |
|
|
|
48 |
Die Iro API wird über verschiedene Interfaces bereit gestellt, die unterschiedlich angesprochen werden, aber das selbe tun. |
|
72
|
49 |
</p> |
|
|
50 |
<div class="item" id="interface-xmlrpc"> |
|
|
51 |
<h4>XML-RPC</h4> |
|
|
52 |
<p> |
|
73
|
53 |
Interface-URI: <code>http://localhost:8000/xmlrpc</code> |
|
72
|
54 |
</p> |
|
|
55 |
<p> |
|
|
56 |
Die aufgerufene Methode wird dabei im <code><methodName /></code> übergeben. |
|
|
57 |
</p> |
|
73
|
58 |
</div> |
|
|
59 |
<div class="item" id="interface-soap"> |
|
|
60 |
<h4>SOAP</h4> |
|
72
|
61 |
<p> |
|
73
|
62 |
Interface-URI: <code>http://localhost:8000/soap</code> |
|
72
|
63 |
</p> |
|
|
64 |
<p> |
|
73
|
65 |
Die aufgerufene Methode wird dabei im <code><methodName /></code> übergeben. |
|
72
|
66 |
</p> |
|
|
67 |
</div> |
|
|
68 |
<div class="item" id="interface-xml"> |
|
|
69 |
<h4>XML</h4> |
|
|
70 |
<p> |
|
73
|
71 |
Interface-URI: <code>http://localhost:8000/xml/<em><methode></em></code> |
|
72
|
72 |
</p> |
|
|
73 |
<p> |
|
|
74 |
Die aufgerufene Methode wird im Pfad der Interface-URI übergeben. |
|
|
75 |
</p> |
|
|
76 |
<p> |
|
|
77 |
Parameter können via HTTP per GET oder POST im Format <em>application/x-www-form-urlencoded</em> übergeben werden. |
|
|
78 |
</p> |
|
|
79 |
<p> |
|
|
80 |
Die Ausgabe erfolgt als XML Markup. |
|
|
81 |
</p> |
|
|
82 |
</div> |
|
|
83 |
<div class="item" id="interface-json"> |
|
|
84 |
<h4>JSON</h4> |
|
|
85 |
<p> |
|
73
|
86 |
Interface-URI: <code>http://localhost:8000/json/<em><methode></em></code> |
|
72
|
87 |
</p> |
|
|
88 |
<p> |
|
|
89 |
Die aufgerufene Methode wird im Pfad der Interface-URI übergeben. |
|
|
90 |
</p> |
|
|
91 |
<p> |
|
|
92 |
Parameter können via HTTP per GET oder POST im Format <em>application/x-www-form-urlencoded</em> oder JSON-Objekt übergeben werden. |
|
|
93 |
</p> |
|
|
94 |
<p> |
|
|
95 |
Die Ausgabe erfolgt als JSON-Objekt. |
|
|
96 |
</p> |
|
|
97 |
</div> |
|
73
|
98 |
<div class="item" id="interface-jsonp"> |
|
72
|
99 |
<h4>JSONP</h4> |
|
|
100 |
<p> |
|
73
|
101 |
Interface-URI: <code>http://localhost:8000/jsonp/<em><methode></em>?callback=<callback></code> |
|
72
|
102 |
</p> |
|
|
103 |
<p> |
|
|
104 |
Die aufgerufene Methode wird im Pfad der Interface-URI übergeben. |
|
|
105 |
</p> |
|
|
106 |
<p> |
|
|
107 |
Der Name für die Callback-Methode wird als Parameter Callback übergeben. |
|
|
108 |
</p> |
|
|
109 |
<p> |
|
|
110 |
Parameter können via HTTP per GET im Format <em>application/x-www-form-urlencoded</em> übergeben werden. |
|
|
111 |
</p> |
|
|
112 |
<p> |
|
|
113 |
Die Ausgabe erfolgt als Javascript-Funktionsaufruf mit einem JSON-Objekt als Parameter. |
|
|
114 |
</p> |
|
|
115 |
</div> |
|
73
|
116 |
</div> |
|
|
117 |
<div class="item" id="api-methods"> |
|
|
118 |
<h3>Methoden</h3> |
|
|
119 |
<div py:for="method in new" class="item" id="method-${method.name}"> |
|
|
120 |
<h4>${method.title}</h4> |
|
|
121 |
<p><code>${method.name}${method.func_line}</code></p> |
|
|
122 |
<p py:content="method.description"> |
|
|
123 |
Diese Methode at bis jetzt noch keine Beschreibung. |
|
72
|
124 |
</p> |
|
73
|
125 |
<h5>Parameter</h5> |
|
|
126 |
<table class="docs"> |
|
|
127 |
<thead> |
|
|
128 |
<tr> |
|
|
129 |
<td>Parameter</td> |
|
|
130 |
<td>Typ</td> |
|
|
131 |
<td>Beschreibung</td> |
|
|
132 |
</tr> |
|
|
133 |
</thead> |
|
|
134 |
<tbody> |
|
|
135 |
<tr py:for="arg in method.args"> |
|
|
136 |
<td>${arg.name}</td> |
|
|
137 |
<td>${arg.typ}</td> |
|
|
138 |
<td>${arg.description}</td> |
|
|
139 |
</tr> |
|
|
140 |
</tbody> |
|
|
141 |
</table> |
|
|
142 |
<py:if test="method.rets"> |
|
|
143 |
<h5>Ausgabe</h5> |
|
|
144 |
<table class="docs"> |
|
|
145 |
<thead> |
|
|
146 |
<tr> |
|
|
147 |
<td>Parameter</td> |
|
|
148 |
<td>Typ</td> |
|
|
149 |
<td>Beschreibung</td> |
|
|
150 |
</tr> |
|
|
151 |
</thead> |
|
|
152 |
<tbody> |
|
|
153 |
<tr py:for="arg in method.rets"> |
|
|
154 |
<td>${arg.name}</td> |
|
|
155 |
<td>${arg.typ}</td> |
|
|
156 |
<td>${arg.description}</td> |
|
|
157 |
</tr> |
|
|
158 |
</tbody> |
|
|
159 |
</table> |
|
|
160 |
</py:if> |
|
72
|
161 |
</div> |
|
|
162 |
</div> |
|
|
163 |
</body> |
|
|
164 |
</html> |