1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> |
|
2 <html> |
|
3 |
|
4 |
|
5 <head> |
|
6 <title>Iro · api docs new</title> |
|
7 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
|
8 <meta charset="utf-8"> |
|
9 <meta name="description" content=""> |
|
10 <meta name="keywords" content=""> |
|
11 <link rel="shortcut icon" type="image/x-icon" href="images/favicon.png"> |
|
12 <link rel="stylesheet" href="css/reset.css" type="text/css" media="screen"> |
|
13 <link rel="stylesheet" href="css/960.css" type="text/css" media="screen"> |
|
14 <link rel="stylesheet" href="css/style.css" type="text/css" media="screen"> |
|
15 <!--[if IE]><link rel="stylesheet" href="css/style-ie.css" type="text/css" media="screen" /><![endif] --> |
|
16 </head> |
|
17 <body> |
|
18 <div id="head-container"> |
|
19 <div id="head"> |
|
20 <h1 id="logo"><a href="index.html" class="logo" title="Netzguerilla"><span>Netzguerilla</span></a></h1> |
|
21 <ul id="menu"> |
|
22 <li><a href="index.html" class="menu">Iro</a></li><li><a href="current.html" class="menu">API Documentation</a></li><li><a href="new.html" class="menu active">geplante API Documentation</a></li><li><a href="impressum.html" class="menu">Impressum</a></li> |
|
23 </ul> |
|
24 </div> |
|
25 </div> |
|
26 <div id="content-container"> |
|
27 <div id="content" class="container_12"> |
|
28 <div id="main" class="grid_9"> |
|
29 <h2>geplante API Dokumentation</h2> |
|
30 <div class="item"> |
|
31 <p> |
|
32 </p> |
|
33 <ol> |
|
34 <li value="1">1. <a href="#api-intro">Einführung</a></li> |
|
35 <li value="2">2. |
|
36 <a href="#api-interfaces">Interfaces</a> |
|
37 <ol> |
|
38 <li value="2.1">2.1 <a href="#interface-xmlrpc">XML-RPC</a></li> |
|
39 <li value="2.1">2.1 <a href="#interface-soap">SOAP</a></li> |
|
40 <li value="2.2">2.2 <a href="#interface-xml">XML</a></li> |
|
41 <li value="2.3">2.3 <a href="#interface-json">JSON</a></li> |
|
42 <li value="2.4">2.4 <a href="#interface-jsonp">JSONP</a></li> |
|
43 <li value="2.5">2.5 <a href="#interface-php">PHP</a></li> |
|
44 </ol> |
|
45 </li> |
|
46 <li value="3">3. |
|
47 <a href="#api-methods">Methoden</a> |
|
48 <ol> |
|
49 <li value="3.1">3.1 <a href="#method-sms">Sms</a></li><li value="3.2">3.2 <a href="#method-fax">Fax</a></li><li value="3.3">3.3 <a href="#method-mail">Mail</a></li><li value="3.4">3.4 <a href="#method-status">Status</a></li><li value="3.5">3.5 <a href="#method-stop">Stop</a></li><li value="3.6">3.6 <a href="#method-routes">Routes</a></li><li value="3.7">3.7 <a href="#method-defaultRoute">DefaultRoute</a></li> |
|
50 </ol> |
|
51 </li> |
|
52 </ol> |
|
53 </div><div class="item" id="api-intro"> |
|
54 <h3>Einführung</h3> |
|
55 <p> |
|
56 Die Iro API enthält Funktion, die für den Massenversand nützlich sind. |
|
57 </p> |
|
58 </div><div class="item" id="api-interfaces"> |
|
59 <h3>Interfaces</h3> |
|
60 <p> |
|
61 Die Iro API wird über verschiedene Interfaces bereit gestellt, die unterschiedlich angesprochen werden, aber das selbe tun. |
|
62 </p> |
|
63 <div class="item" id="interface-xmlrpc"> |
|
64 <h4>XML-RPC</h4> |
|
65 <p> |
|
66 Interface-URI: <code>http://localhost:8000/xmlrpc</code> |
|
67 </p> |
|
68 <p> |
|
69 Die aufgerufene Methode wird dabei im <code><methodName /></code> übergeben. |
|
70 </p> |
|
71 </div> |
|
72 <div class="item" id="interface-soap"> |
|
73 <h4>SOAP</h4> |
|
74 <p> |
|
75 Interface-URI: <code>http://localhost:8000/soap</code> |
|
76 </p> |
|
77 <p> |
|
78 Die aufgerufene Methode wird dabei im <code><methodName /></code> übergeben. |
|
79 </p> |
|
80 </div> |
|
81 <div class="item" id="interface-xml"> |
|
82 <h4>XML</h4> |
|
83 <p> |
|
84 Interface-URI: <code>http://localhost:8000/xml/<em><methode></em></code> |
|
85 </p> |
|
86 <p> |
|
87 Die aufgerufene Methode wird im Pfad der Interface-URI übergeben. |
|
88 </p> |
|
89 <p> |
|
90 Parameter können via HTTP per GET oder POST im Format <em>application/x-www-form-urlencoded</em> übergeben werden. |
|
91 </p> |
|
92 <p> |
|
93 Die Ausgabe erfolgt als XML Markup. |
|
94 </p> |
|
95 </div> |
|
96 <div class="item" id="interface-json"> |
|
97 <h4>JSON</h4> |
|
98 <p> |
|
99 Interface-URI: <code>http://localhost:8000/json/<em><methode></em></code> |
|
100 </p> |
|
101 <p> |
|
102 Die aufgerufene Methode wird im Pfad der Interface-URI übergeben. |
|
103 </p> |
|
104 <p> |
|
105 Parameter können via HTTP per GET oder POST im Format <em>application/x-www-form-urlencoded</em> oder JSON-Objekt übergeben werden. |
|
106 </p> |
|
107 <p> |
|
108 Die Ausgabe erfolgt als JSON-Objekt. |
|
109 </p> |
|
110 </div> |
|
111 <div class="item" id="interface-jsonp"> |
|
112 <h4>JSONP</h4> |
|
113 <p> |
|
114 Interface-URI: <code>http://localhost:8000/jsonp/<em><methode></em>?callback=<callback></code> |
|
115 </p> |
|
116 <p> |
|
117 Die aufgerufene Methode wird im Pfad der Interface-URI übergeben. |
|
118 </p> |
|
119 <p> |
|
120 Der Name für die Callback-Methode wird als Parameter Callback übergeben. |
|
121 </p> |
|
122 <p> |
|
123 Parameter können via HTTP per GET im Format <em>application/x-www-form-urlencoded</em> übergeben werden. |
|
124 </p> |
|
125 <p> |
|
126 Die Ausgabe erfolgt als Javascript-Funktionsaufruf mit einem JSON-Objekt als Parameter. |
|
127 </p> |
|
128 </div> |
|
129 </div><div class="item" id="api-methods"> |
|
130 <h3>Methoden</h3> |
|
131 <div class="item" id="method-sms"> |
|
132 <h4>Sms</h4> |
|
133 <p><code>sms(apikey, message, recipients, route='default')</code></p> |
|
134 <p>Versendet eine SMS.</p> |
|
135 <h5>Parameter</h5> |
|
136 <table class="docs"> |
|
137 <thead> |
|
138 <tr> |
|
139 <td>Parameter</td> |
|
140 <td>Typ</td> |
|
141 <td>Beschreibung</td> |
|
142 </tr> |
|
143 </thead> |
|
144 <tbody> |
|
145 <tr> |
|
146 <td>apikey</td> |
|
147 <td>string</td> |
|
148 <td> Der API Key</td> |
|
149 </tr><tr> |
|
150 <td>message</td> |
|
151 <td>string</td> |
|
152 <td> Nachricht</td> |
|
153 </tr><tr> |
|
154 <td>recipients</td> |
|
155 <td>list</td> |
|
156 <td> eine Liste von Emfänger-Nummern (gemäß ITU-T E.123)</td> |
|
157 </tr><tr> |
|
158 <td>route</td> |
|
159 <td>string|list</td> |
|
160 <td> Route über den geschickt werden soll, |
|
161 oder eine Liste von Routen, um Fallbacks anzugeben</td> |
|
162 </tr> |
|
163 </tbody> |
|
164 </table> |
|
165 <h5>Ausgabe</h5> |
|
166 <table class="docs"> |
|
167 <thead> |
|
168 <tr> |
|
169 <td>Parameter</td> |
|
170 <td>Typ</td> |
|
171 <td>Beschreibung</td> |
|
172 </tr> |
|
173 </thead> |
|
174 <tbody> |
|
175 <tr> |
|
176 <td>id</td> |
|
177 <td>hash</td> |
|
178 <td> Die ID des Auftrages</td> |
|
179 </tr> |
|
180 </tbody> |
|
181 </table> |
|
182 </div><div class="item" id="method-fax"> |
|
183 <h4>Fax</h4> |
|
184 <p><code>fax(apikey, subject, fax, recipients, route='default')</code></p> |
|
185 <p>Versendet ein FAX.</p> |
|
186 <h5>Parameter</h5> |
|
187 <table class="docs"> |
|
188 <thead> |
|
189 <tr> |
|
190 <td>Parameter</td> |
|
191 <td>Typ</td> |
|
192 <td>Beschreibung</td> |
|
193 </tr> |
|
194 </thead> |
|
195 <tbody> |
|
196 <tr> |
|
197 <td>apikey</td> |
|
198 <td>string</td> |
|
199 <td> Der API Key</td> |
|
200 </tr><tr> |
|
201 <td>subject</td> |
|
202 <td>string</td> |
|
203 <td> Der Betreff</td> |
|
204 </tr><tr> |
|
205 <td>fax</td> |
|
206 <td>string</td> |
|
207 <td> Das PDF base64 kodiert</td> |
|
208 </tr><tr> |
|
209 <td>recipients</td> |
|
210 <td>list</td> |
|
211 <td> Eine Liste von Emfänger-Nummern (gemäß ITU-T E.123)</td> |
|
212 </tr><tr> |
|
213 <td>route</td> |
|
214 <td>string|list</td> |
|
215 <td> Route über den geschickt werden soll, |
|
216 oder eine Liste von Routen, um Fallbacks anzugeben</td> |
|
217 </tr> |
|
218 </tbody> |
|
219 </table> |
|
220 <h5>Ausgabe</h5> |
|
221 <table class="docs"> |
|
222 <thead> |
|
223 <tr> |
|
224 <td>Parameter</td> |
|
225 <td>Typ</td> |
|
226 <td>Beschreibung</td> |
|
227 </tr> |
|
228 </thead> |
|
229 <tbody> |
|
230 <tr> |
|
231 <td>id</td> |
|
232 <td>hash</td> |
|
233 <td> Die ID des Auftrages</td> |
|
234 </tr> |
|
235 </tbody> |
|
236 </table> |
|
237 </div><div class="item" id="method-mail"> |
|
238 <h4>Mail</h4> |
|
239 <p><code>mail(apikey, subject, body, recipients, frm, route='default')</code></p> |
|
240 <p>Versendet eine Email.</p> |
|
241 <h5>Parameter</h5> |
|
242 <table class="docs"> |
|
243 <thead> |
|
244 <tr> |
|
245 <td>Parameter</td> |
|
246 <td>Typ</td> |
|
247 <td>Beschreibung</td> |
|
248 </tr> |
|
249 </thead> |
|
250 <tbody> |
|
251 <tr> |
|
252 <td>apikey</td> |
|
253 <td>string</td> |
|
254 <td> Der API Key</td> |
|
255 </tr><tr> |
|
256 <td>subject</td> |
|
257 <td>string</td> |
|
258 <td> Der Betreff</td> |
|
259 </tr><tr> |
|
260 <td>body</td> |
|
261 <td>string</td> |
|
262 <td> Der Email Body</td> |
|
263 </tr><tr> |
|
264 <td>recipients</td> |
|
265 <td>list</td> |
|
266 <td> Eine Liste von Emailadressen</td> |
|
267 </tr><tr> |
|
268 <td>frm</td> |
|
269 <td>string</td> |
|
270 <td> Die Absender Emailadresse</td> |
|
271 </tr><tr> |
|
272 <td>route</td> |
|
273 <td>string|list</td> |
|
274 <td> Route über den geschickt werden soll, |
|
275 oder eine Liste von Routen, um Fallbacks anzugeben</td> |
|
276 </tr> |
|
277 </tbody> |
|
278 </table> |
|
279 <h5>Ausgabe</h5> |
|
280 <table class="docs"> |
|
281 <thead> |
|
282 <tr> |
|
283 <td>Parameter</td> |
|
284 <td>Typ</td> |
|
285 <td>Beschreibung</td> |
|
286 </tr> |
|
287 </thead> |
|
288 <tbody> |
|
289 <tr> |
|
290 <td>id</td> |
|
291 <td>hash</td> |
|
292 <td> Die ID des Auftrages</td> |
|
293 </tr> |
|
294 </tbody> |
|
295 </table> |
|
296 </div><div class="item" id="method-status"> |
|
297 <h4>Status</h4> |
|
298 <p><code>status(apikey, id=None, detailed=False)</code></p> |
|
299 <p>Gibt den aktuellen Status eines Auftrages zurück.</p> |
|
300 <h5>Parameter</h5> |
|
301 <table class="docs"> |
|
302 <thead> |
|
303 <tr> |
|
304 <td>Parameter</td> |
|
305 <td>Typ</td> |
|
306 <td>Beschreibung</td> |
|
307 </tr> |
|
308 </thead> |
|
309 <tbody> |
|
310 <tr> |
|
311 <td>apikey</td> |
|
312 <td>string</td> |
|
313 <td> Der API Key</td> |
|
314 </tr><tr> |
|
315 <td>id</td> |
|
316 <td>hash</td> |
|
317 <td> Eine Auftragsnummer</td> |
|
318 </tr><tr> |
|
319 <td>detailed</td> |
|
320 <td>boolean</td> |
|
321 <td> Details ausgeben</td> |
|
322 </tr> |
|
323 </tbody> |
|
324 </table> |
|
325 <h5>Ausgabe</h5> |
|
326 <table class="docs"> |
|
327 <thead> |
|
328 <tr> |
|
329 <td>Parameter</td> |
|
330 <td>Typ</td> |
|
331 <td>Beschreibung</td> |
|
332 </tr> |
|
333 </thead> |
|
334 <tbody> |
|
335 <tr> |
|
336 <td>jobs</td> |
|
337 <td>list</td> |
|
338 <td> Eine Liste der Aufträge.</td> |
|
339 </tr><tr> |
|
340 <td>job.name</td> |
|
341 <td>string</td> |
|
342 <td> Angebener Name</td> |
|
343 </tr><tr> |
|
344 <td>job.status</td> |
|
345 <td>string</td> |
|
346 <td> Status des Auftrages</td> |
|
347 </tr> |
|
348 </tbody> |
|
349 </table> |
|
350 </div><div class="item" id="method-stop"> |
|
351 <h4>Stop</h4> |
|
352 <p><code>stop(apikey, id)</code></p> |
|
353 <p>Stoppt den angegeben Auftrag.</p> |
|
354 <h5>Parameter</h5> |
|
355 <table class="docs"> |
|
356 <thead> |
|
357 <tr> |
|
358 <td>Parameter</td> |
|
359 <td>Typ</td> |
|
360 <td>Beschreibung</td> |
|
361 </tr> |
|
362 </thead> |
|
363 <tbody> |
|
364 <tr> |
|
365 <td>apikey</td> |
|
366 <td>string</td> |
|
367 <td> Der API Key</td> |
|
368 </tr><tr> |
|
369 <td>id</td> |
|
370 <td>hash</td> |
|
371 <td> Eine Auftragsnummer</td> |
|
372 </tr> |
|
373 </tbody> |
|
374 </table> |
|
375 </div><div class="item" id="method-routes"> |
|
376 <h4>Routes</h4> |
|
377 <p><code>routes(apikey, typ)</code></p> |
|
378 <p>Gibt eine Liste aller verfügbaren Provider zurück.</p> |
|
379 <h5>Parameter</h5> |
|
380 <table class="docs"> |
|
381 <thead> |
|
382 <tr> |
|
383 <td>Parameter</td> |
|
384 <td>Typ</td> |
|
385 <td>Beschreibung</td> |
|
386 </tr> |
|
387 </thead> |
|
388 <tbody> |
|
389 <tr> |
|
390 <td>apikey</td> |
|
391 <td>string</td> |
|
392 <td> Der API Key</td> |
|
393 </tr><tr> |
|
394 <td>typ</td> |
|
395 <td>string</td> |
|
396 <td> Der Typ zu dem die Providerloste ausgeben werden soll |
|
397 Einer der Liste ["sms","fax","mail"]</td> |
|
398 </tr> |
|
399 </tbody> |
|
400 </table> |
|
401 <h5>Ausgabe</h5> |
|
402 <table class="docs"> |
|
403 <thead> |
|
404 <tr> |
|
405 <td>Parameter</td> |
|
406 <td>Typ</td> |
|
407 <td>Beschreibung</td> |
|
408 </tr> |
|
409 </thead> |
|
410 <tbody> |
|
411 <tr> |
|
412 <td>providerlist</td> |
|
413 <td>list</td> |
|
414 <td> Eine Liste aller möglichen Provider</td> |
|
415 </tr> |
|
416 </tbody> |
|
417 </table> |
|
418 </div><div class="item" id="method-defaultRoute"> |
|
419 <h4>DefaultRoute</h4> |
|
420 <p><code>defaultRoute(apikey, typ)</code></p> |
|
421 <p>Gibt den Standardprovider zurück.</p> |
|
422 <h5>Parameter</h5> |
|
423 <table class="docs"> |
|
424 <thead> |
|
425 <tr> |
|
426 <td>Parameter</td> |
|
427 <td>Typ</td> |
|
428 <td>Beschreibung</td> |
|
429 </tr> |
|
430 </thead> |
|
431 <tbody> |
|
432 <tr> |
|
433 <td>apikey</td> |
|
434 <td>string</td> |
|
435 <td> Der API Key</td> |
|
436 </tr><tr> |
|
437 <td>typ</td> |
|
438 <td>string</td> |
|
439 <td> Der Typ zu dem die Providerloste ausgeben werden soll |
|
440 Einer der Liste ["sms","fax","mail"]</td> |
|
441 </tr> |
|
442 </tbody> |
|
443 </table> |
|
444 <h5>Ausgabe</h5> |
|
445 <table class="docs"> |
|
446 <thead> |
|
447 <tr> |
|
448 <td>Parameter</td> |
|
449 <td>Typ</td> |
|
450 <td>Beschreibung</td> |
|
451 </tr> |
|
452 </thead> |
|
453 <tbody> |
|
454 <tr> |
|
455 <td>provider</td> |
|
456 <td>string</td> |
|
457 <td> Der Standardprovider für den angeben Typ</td> |
|
458 </tr> |
|
459 </tbody> |
|
460 </table> |
|
461 </div> |
|
462 </div> |
|
463 </div> |
|
464 <div class="clear"></div> |
|
465 </div> |
|
466 </div> |
|
467 <div id="foot-container"> |
|
468 <div id="foot"> |
|
469 <p>© 2010-2011 <a href="impressum.html">Netzguerilla.net</a>.</p> |
|
470 </div> |
|
471 </div> |
|
472 </body> |
|
473 </html> |
|