# HG changeset patch # User Sandro Knauß # Date 1335304989 -7200 # Node ID 170dfb7822317c92f7db7ccf342d6d889c41b5f9 # Parent 97826c8248f93ed2e3cc272aa6c8e7d5a26cead0 doc: switsching to english impressum -> about diff -r 97826c8248f9 -r 170dfb782231 doc/about.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/about.html Wed Apr 25 00:03:09 2012 +0200 @@ -0,0 +1,62 @@ + + + + + + Iro · About us + + + + + + + + + + + +
+ +
+
+
+
+

About us

+
+

Contact

+

+ Netzguerilla.net Clerc Knauß Vollnhals GbR
+ Manteuffelstraße 40
+ 10997 Berlin +

+

+ WWW: netzguerilla.net
+

+

+ E-Mail: iro@netzguerilla.net
+

+

+ Telefon: +49 30 69201075
+

+

German legal notice - Inhaltlich verantwortlich

+

+ Verantwortlich für den Inhalt nach § 55 Abs. 2 RStV bzw. §5 TMG sowie beauftragt mit dem Jugendschutz gemäß TMG, JMStV sowie GjSM:
+ Sandro Knauß, Anschrift wie oben, iro@netzguerilla.net +

+
+
+
+
+
+
+ +
+ + \ No newline at end of file diff -r 97826c8248f9 -r 170dfb782231 doc/impressum.html --- a/doc/impressum.html Tue Apr 24 23:59:00 2012 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,62 +0,0 @@ - - - - - - Iro · Impressum - - - - - - - - - - - -
- -
-
-
-
-

Impressum

-
-

Kontakt

-

- Netzguerilla.net Clerc Knauß Vollnhals GbR
- Manteuffelstraße 40
- 10997 Berlin -

-

- WWW: netzguerilla.net
-

-

- E-Mail: iro@netzguerilla.net
-

-

- Telefon: +49 30 69201075
-

-

Inhaltlich verantwortlich

-

- Verantwortlich für den Inhalt nach § 55 Abs. 2 RStV bzw. §5 TMG sowie beauftragt mit dem Jugendschutz gemäß TMG, JMStV sowie GjSM:
- Sandro Knauß, Anschrift wie oben, iro@netzguerilla.net -

-
-
-
-
-
-
- -
- - \ No newline at end of file diff -r 97826c8248f9 -r 170dfb782231 doc/new.html --- a/doc/new.html Tue Apr 24 23:59:00 2012 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,473 +0,0 @@ - - - - - - Iro · api docs new - - - - - - - - - - - -
- -
-
-
-
-

geplante API Dokumentation

-
-

-

-
    -
  1. 1. Einführung
    2. -
  2. 2. - Interfaces -
      -
    1. 2.1 XML-RPC
      2. -
    2. 2.1 SOAP
      3. -
    3. 2.2 XML
      4. -
    4. 2.3 JSON
      5. -
    5. 2.4 JSONP
      6. -
    6. 2.5 PHP
      7. -
    -
    3. -
  3. 3. - Methoden -
      -
    1. 3.1 Sms
    2. 3.2 Fax
    3. 3.3 Mail
    4. 3.4 Status
    5. 3.5 Stop
    6. 3.6 Routes
    7. 3.7 DefaultRoute
      8. -
    -
    4. -
-
-

Einführung

-

- Die Iro API enthält Funktion, die für den Massenversand nützlich sind. -

-
-

Interfaces

-

- Die Iro API wird über verschiedene Interfaces bereit gestellt, die unterschiedlich angesprochen werden, aber das selbe tun. -

-
-

XML-RPC

-

- Interface-URI: http://localhost:8000/xmlrpc -

-

- Die aufgerufene Methode wird dabei im <methodName /> übergeben. -

-
-
-

SOAP

-

- Interface-URI: http://localhost:8000/soap -

-

- Die aufgerufene Methode wird dabei im <methodName /> übergeben. -

-
-
-

XML

-

- Interface-URI: http://localhost:8000/xml/<methode> -

-

- Die aufgerufene Methode wird im Pfad der Interface-URI übergeben. -

-

- Parameter können via HTTP per GET oder POST im Format application/x-www-form-urlencoded übergeben werden. -

-

- Die Ausgabe erfolgt als XML Markup. -

-
-
-

JSON

-

- Interface-URI: http://localhost:8000/json/<methode> -

-

- Die aufgerufene Methode wird im Pfad der Interface-URI übergeben. -

-

- Parameter können via HTTP per GET oder POST im Format application/x-www-form-urlencoded oder JSON-Objekt übergeben werden. -

-

- Die Ausgabe erfolgt als JSON-Objekt. -

-
-
-

JSONP

-

- Interface-URI: http://localhost:8000/jsonp/<methode>?callback=<callback> -

-

- Die aufgerufene Methode wird im Pfad der Interface-URI übergeben. -

-

- Der Name für die Callback-Methode wird als Parameter Callback übergeben. -

-

- Parameter können via HTTP per GET im Format application/x-www-form-urlencoded übergeben werden. -

-

- Die Ausgabe erfolgt als Javascript-Funktionsaufruf mit einem JSON-Objekt als Parameter. -

-
-
-

Methoden

-
-

Sms

-

sms(apikey, message, recipients, route='default')

-

Versendet eine SMS.

-
Parameter
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterTypBeschreibung
apikeystring Der API Key
messagestring Nachricht
recipientslist eine Liste von Emfänger-Nummern (gemäß ITU-T E.123)
routestring|list Route über den geschickt werden soll, -oder eine Liste von Routen, um Fallbacks anzugeben
-
Ausgabe
- - - - - - - - - - - - - - - -
ParameterTypBeschreibung
idhash Die ID des Auftrages
-
-

Fax

-

fax(apikey, subject, fax, recipients, route='default')

-

Versendet ein FAX.

-
Parameter
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterTypBeschreibung
apikeystring Der API Key
subjectstring Der Betreff
faxstring Das PDF base64 kodiert
recipientslist Eine Liste von Emfänger-Nummern (gemäß ITU-T E.123)
routestring|list Route über den geschickt werden soll, -oder eine Liste von Routen, um Fallbacks anzugeben
-
Ausgabe
- - - - - - - - - - - - - - - -
ParameterTypBeschreibung
idhash Die ID des Auftrages
-
-

Mail

-

mail(apikey, subject, body, recipients, frm, route='default')

-

Versendet eine Email.

-
Parameter
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterTypBeschreibung
apikeystring Der API Key
subjectstring Der Betreff
bodystring Der Email Body
recipientslist Eine Liste von Emailadressen
frmstring Die Absender Emailadresse
routestring|list Route über den geschickt werden soll, -oder eine Liste von Routen, um Fallbacks anzugeben
-
Ausgabe
- - - - - - - - - - - - - - - -
ParameterTypBeschreibung
idhash Die ID des Auftrages
-
-

Status

-

status(apikey, id=None, detailed=False)

-

Gibt den aktuellen Status eines Auftrages zurück.

-
Parameter
- - - - - - - - - - - - - - - - - - - - - - - -
ParameterTypBeschreibung
apikeystring Der API Key
idhash Eine Auftragsnummer
detailedboolean Details ausgeben
-
Ausgabe
- - - - - - - - - - - - - - - - - - - - - - - -
ParameterTypBeschreibung
jobslist Eine Liste der Aufträge.
job.namestring Angebener Name
job.statusstring Status des Auftrages
-
-

Stop

-

stop(apikey, id)

-

Stoppt den angegeben Auftrag.

-
Parameter
- - - - - - - - - - - - - - - - - - - -
ParameterTypBeschreibung
apikeystring Der API Key
idhash Eine Auftragsnummer
-
-

Routes

-

routes(apikey, typ)

-

Gibt eine Liste aller verfügbaren Provider zurück.

-
Parameter
- - - - - - - - - - - - - - - - - - - -
ParameterTypBeschreibung
apikeystring Der API Key
typstring Der Typ zu dem die Providerloste ausgeben werden soll -Einer der Liste ["sms","fax","mail"]
-
Ausgabe
- - - - - - - - - - - - - - - -
ParameterTypBeschreibung
providerlistlist Eine Liste aller möglichen Provider
-
-

DefaultRoute

-

defaultRoute(apikey, typ)

-

Gibt den Standardprovider zurück.

-
Parameter
- - - - - - - - - - - - - - - - - - - -
ParameterTypBeschreibung
apikeystring Der API Key
typstring Der Typ zu dem die Providerloste ausgeben werden soll -Einer der Liste ["sms","fax","mail"]
-
Ausgabe
- - - - - - - - - - - - - - - -
ParameterTypBeschreibung
providerstring Der Standardprovider für den angeben Typ
-
-
-
-
-
-
-
- -
- - \ No newline at end of file diff -r 97826c8248f9 -r 170dfb782231 doc/tmpl/about.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/tmpl/about.html Wed Apr 25 00:03:09 2012 +0200 @@ -0,0 +1,36 @@ + + + + + About us + + + About us + +
+

Contact

+

+ Netzguerilla.net Clerc Knauß Vollnhals GbR
+ Manteuffelstraße 40
+ 10997 Berlin +

+

+ WWW: netzguerilla.net
+

+

+ E-Mail: iro@netzguerilla.net
+

+

+ Telefon: +49 30 69201075
+

+

German legal notice - Inhaltlich verantwortlich

+

+ Verantwortlich für den Inhalt nach § 55 Abs. 2 RStV bzw. §5 TMG sowie beauftragt mit dem Jugendschutz gemäß TMG, JMStV sowie GjSM:
+ Sandro Knauß, Anschrift wie oben, iro@netzguerilla.net +

+
+ + diff -r 97826c8248f9 -r 170dfb782231 doc/tmpl/impressum.html --- a/doc/tmpl/impressum.html Tue Apr 24 23:59:00 2012 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,36 +0,0 @@ - - - - - Impressum - - - Impressum - -
-

Kontakt

-

- Netzguerilla.net Clerc Knauß Vollnhals GbR
- Manteuffelstraße 40
- 10997 Berlin -

-

- WWW: netzguerilla.net
-

-

- E-Mail: iro@netzguerilla.net
-

-

- Telefon: +49 30 69201075
-

-

Inhaltlich verantwortlich

-

- Verantwortlich für den Inhalt nach § 55 Abs. 2 RStV bzw. §5 TMG sowie beauftragt mit dem Jugendschutz gemäß TMG, JMStV sowie GjSM:
- Sandro Knauß, Anschrift wie oben, iro@netzguerilla.net -

-
- -