3 <html xmlns="http://www.w3.org/1999/xhtml" |
3 <html xmlns="http://www.w3.org/1999/xhtml" |
4 xmlns:xi="http://www.w3.org/2001/XInclude" |
4 xmlns:xi="http://www.w3.org/2001/XInclude" |
5 xmlns:py="http://genshi.edgewall.org/"> |
5 xmlns:py="http://genshi.edgewall.org/"> |
6 <xi:include href="layout.tmpl" /> |
6 <xi:include href="layout.tmpl" /> |
7 <head> |
7 <head> |
8 <title>API docs</title> |
8 <title>api docs current</title> |
9 </head> |
9 </head> |
10 <body> |
10 <body> |
11 <title>API Dokumentation</title> |
11 <title>API Documentation</title> |
12 <div class="item"> |
12 <div class="item"> |
13 <p> |
13 <p> |
14 |
14 |
15 </p> |
15 </p> |
16 <ol> |
16 <ol> |
17 <li value="1">1. <a href="#api-intro">Einführung</a></li> |
17 <li value="1">1. <a href="#api-intro">Intro</a></li> |
18 <li value="2">2. |
18 <li value="2">2. |
19 <a href="#api-interfaces">Interfaces</a> |
19 <a href="#api-interfaces">Interfaces</a> |
20 <ol> |
20 <ol> |
21 <li value="2.1">2.1 <a href="#interface-xmlrpc">XML-RPC</a></li> |
21 <li value="2.1">2.1 <a href="#interface-xmlrpc">XML-RPC</a></li> |
22 </ol> |
22 <li value="2.1">2.2 <a href="#interface-soap">SOAP</a></li> |
|
23 <li value="2.3">2.3 <a href="#interface-json">JSON</a></li> |
|
24 <li value="2.4">2.4 <a href="#interface-jsonp">JSONP</a></li> |
|
25 </ol> |
23 </li> |
26 </li> |
24 <li value="3">3. |
27 <li value="3">3. |
25 <a href="#api-methods">Methoden</a> |
28 <a href="#api-methods">Methods</a> |
26 <ol> |
29 <ol> |
27 <li py:for="(key,method) in enumerate(current)" value="3.${key+1}">3.${key+1} <a href="#method-${method.name}">${method.title}</a></li> |
30 <li py:for="(key,method) in enumerate(current)" value="3.${key+1}">3.${key+1} <a href="#method-${method.name}">${method.title}</a></li> |
28 </ol> |
31 </ol> |
29 </li> |
32 </li> |
|
33 |
30 </ol> |
34 </ol> |
31 </div> |
35 </div> |
32 <div class="item" id="api-intro"> |
36 <div class="item" id="api-intro"> |
33 <h3>Einführung</h3> |
37 <h3>Intro</h3> |
34 <p> |
38 <p> |
35 Die Iro API enthält Funktion, die für den Massenversand nützlich sind. |
39 Iro API has many methods, that are usefull if you want to send a bunch of messages. This Site describes the API for Iro 1.0. |
36 </p> |
40 </p> |
37 </div> |
41 </div> |
38 <div class="item" id="api-interfaces"> |
42 <div class="item" id="api-interfaces"> |
39 <h3>Interfaces</h3> |
43 <h3>Interfaces</h3> |
40 <p> |
44 <p> |
41 Die Iro API stellt zur Zeit nur ein Interfaces bereit. |
45 You can use diffrent interfaces to get to same result. |
42 </p> |
46 </p> |
43 <div class="item" id="interface-xmlrpc"> |
47 <div class="item" id="interface-xmlrpc"> |
44 <h4>XML-RPC</h4> |
48 <h4>XML-RPC</h4> |
45 <p> |
49 <p> |
46 Interface-URI: <code>https://<em><benutzer></em>:<em><passwort></em>@localhost:8000</code> |
50 Interface-URI: <code>http://localhost:8000/xmlrpc</code> |
|
51 </p> |
|
52 </div> |
|
53 <div class="item" id="interface-soap"> |
|
54 <h4>SOAP</h4> |
|
55 <p> |
|
56 Interface-URI: <code>http://localhost:8000/soap</code> |
|
57 </p> |
|
58 </div> |
|
59 <div class="item" id="interface-json"> |
|
60 <h4>JSON</h4> |
|
61 <p> |
|
62 Interface-URI: <code>http://localhost:8000/json/<em><methode></em></code> |
47 </p> |
63 </p> |
48 <p> |
64 <p> |
49 Die aufgerufene Methode wird dabei im <code><methodName /></code> übergeben. |
65 Not yet implementet |
|
66 </p> |
|
67 </div> |
|
68 <div class="item" id="interface-jsonp"> |
|
69 <h4>JSONP</h4> |
|
70 <p> |
|
71 Interface-URI: <code>http://localhost:8000/jsonp/<em><methode></em>?callback=<callback></code> |
|
72 </p> |
|
73 <p> |
|
74 Not yet implementet |
50 </p> |
75 </p> |
51 </div> |
76 </div> |
52 </div> |
77 </div> |
53 <div class="item" id="api-methods"> |
78 <div class="item" id="api-methods"> |
54 <h3>Methoden</h3> |
79 <h3>Methods</h3> |
55 <div py:for="method in current" class="item" id="method-${method.name}"> |
80 <div py:for="method in current" class="item" id="method-${method.name}"> |
56 <h4>${method.title}</h4> |
81 <h4>${method.title}</h4> |
57 <p><code>${method.name}${method.func_line}</code></p> |
82 <p><code>${method.name}${method.func_line}</code></p> |
58 <p py:content="method.description"> |
83 <p py:content="method.description"> |
59 Diese Methode at bis jetzt noch keine Beschreibung. |
84 No description |
60 </p> |
85 </p> |
61 <h5>Parameter</h5> |
86 <h5>Parameter</h5> |
62 <table class="docs"> |
87 <table class="docs"> |
63 <thead> |
88 <thead> |
64 <tr> |
89 <tr> |
65 <td>Parameter</td> |
90 <td>parameter</td> |
66 <td>Typ</td> |
91 <td>type</td> |
67 <td>Beschreibung</td> |
92 <td>description</td> |
68 </tr> |
93 </tr> |
69 </thead> |
94 </thead> |
70 <tbody> |
95 <tbody> |
71 <tr py:for="arg in method.args"> |
96 <tr py:for="arg in method.args"> |
72 <td>${arg.name}</td> |
97 <td>${arg.name}</td> |