Entwicklung:Webservices

Inhaltsverzeichnis

actindo Webservices

Einen Überblick über die von actindo zur Verfügung gestellten Webservices finden Sie unter https://www.actindo.biz/actindo/xmlrpc.php bzw. unter https://www.actindo.biz/actindo/soap.php


Support

Support für die Anbindung der Webservices ist nicht im Standard-Support für die actindo Software enthalten. Lassen Sie sich hierzu ein Angebot für den Schnittstellen-Support erstellen.


Nutzung der Webservices

Login

Um die actindo Webservices zu nutzen ist zunächst ein Login nötig. Dazu steht die Methode auth_login [1] zur Verfügung. Von dieser Methode bekommen Sie eine sog. Session-ID zurück, welche Sie bei jedem nachfolgenden Aufruf einer Webservice-Methode übergeben müssen.

Session-ID

Die Session-ID wird nach zwei Stunden Inaktivität ungültig. Möchten Sie nicht, dass die Session-ID trotz Inaktivität erlischt, so rufen Sie am Besten jede Stunde einmal die Methode auth__ping [2] auf.

Speicherung / Wiederverwendung der Session-ID

Wir empfehlen, die Session-ID wiederzuverwenden, sprich während der Laufzeit Ihres Programmes zu speichern, da auth__login zur Vermeidung von Password-Crackern absichtlich um etwa 3-10 Sekunden verzögert wird.

Logout

Durch den Aufruf von auth_logout [3] loggen Sie sich aus dem Webservice aus. Die Session-ID wird durch auth_logout ungültig.


Throtteling

Die actindo Webservices nutzen ein Verfahren namens "throtteling". Das heißt, die Funktionen des actindo Webservice können nicht beliebig schnell hintereinander aufgerufen werden.

Das throttling basiert auf Mandanten: Jeder Mandant hat zu Anfang 200 Punkte. Jeder Aufruf einer get/set-Funktion "kostet" 1 Punkt, alle search/find-Funktionen 2 Punkte, auth__login 10 Punkte.

Die Punkte laden sich dann mit 50 pro Minute wieder auf, jedoch bis maximal 200 Punkte.

Nur bei Login: Login ist ZUSÄTZLICH auf IP-Adressen beschränkt. Jede IP-Adresse erhält 10 Login-IP-Punkte, diese füllen sich mit 4 Login-IP-Punkten pro Minute wieder auf. Jeder Login kostet 1 Login-IP-Punkt (zusätzlich zu den 10 "normalen" Mandanten-Punkten). Das dient dazu, dass sogenannte Brute-Force-Attacken auf das Login-System wesentlich erschwert werden.

Es gibt desweiteren eine Begrenzung für falsche Session-ID's: Werden SOAP / XMLRPC-Methoden (außer auth__login bzw. auth__token_login) mit ungültiger oder falscher Session-ID (erster Parameter) aufgerufen, so wird die IP-Adresse nach 2 falschen Aufrufen für eine Minute gesperrt.

Beispiele

Pseudo-Code-Beispiel

Folgendes Beispiel zeigt die Nutzung der Webservices exemplarisch in Pseudo-Code:

$sid = auth_login( '<Ihr Benutzername>', '<Ihr Passwort>', <Ihre Mandanten-Nummer>, 'NOID', 'NOSERIAL' );
if SoapError or xmlrpcError then Fehlerbehandlung und exit

$result = auth_ping( $sid );
if SoapError or xmlrpcError then ReLogin

/* Weitere Aufrufe und Verarbeitung */

auth_logout( $sid );


PHP SOAP Beispiel

#!/usr/bin/php
<?php

$soap = new SoapClient( 'https://www.actindo.biz/actindo/soap.php?WSDL', array('encoding'=>'iso8859-1') );

try
{
  echo "Logging in...\n";
  $sid = $soap->auth__login( 'test', 'test', 10000, 'NOID' );


  echo "Getting user info...\n";
  $arr = $soap->auth__get_user_properties( $sid );

  echo "Got user info:\n";
  var_dump($arr);


  echo "Logging out...\n";
  $soap->auth__logout( $sid );

  echo "Done.\n";
}
catch( Exception $e )
{
  var_dump( $e );
}

?>

Zulässige Werte für die Übergabe

Anreden:

'Firma' => 'Firma',
'Herr' => 'Herr',
'Frau' => 'Frau',
'Herrn und Frau' => 'Herrn und Frau',
'Dr.' => 'Dr.',
'Prof.' => 'Prof.',
=> '-keine-',

Währungen:

| AED | United Arab Emirates Dirhams |
| AFA | Afghanistan Afghanis |
| AFN | Afghanistan Afghanis |
| ALL | Albania Leke |
| ARS | Argentina Pesos |
| AUD | Australia Dollars |
| BBD | Barbados Dollars |
| BDT | Bangladesh Taka |
| BGL | Bulgaria Leva |
| BGN | Bulgaria Leva |
| BHD | Bahrain Dinars |
| BMD | Bermuda Dollars |
| BRL | Brazil Reals |
| BSD | Bahamas Dollars |
| CAD | Canada Dollars |
| CHF | Switzerland Francs |
| CLP | Chile Pesos |
| CNY | China Yuan Renminbi |
| COP | Colombia Pesos |
| CRC | Costa Rica Colones |
| CYP | Cyprus Pounds |
| CZK | Czech Republic Koruny |
| DEM | German Marks |
| DKK | Denmark Kroner |
| DOP | Dominican Republic Pesos |
| DZD | Algeria Dinars |
| EEK | Estonia Krooni |
| EGP | Egypt Pounds |
| EUR | Euro |
| FJD | Fiji Dollars |
| GBP | United Kingdom Pounds |
| HKD | Hong Kong Dollars |
| HRK | Croatia Kuna |
| HUF | Hungary Forint |
| IDR | Indonesia Rupiahs |
| ILS | Israel New Shekels |
| INR | India Rupees |
| IQD | Iraq Dinars |
| IRR | Iran Rials |
| ISK | Iceland Kronur |
| JMD | Jamaica Dollars |
| JOD | Jordan Dinars |
| JPY | Japan Yen |
| KES | Kenya Shillings |
| KRW | South Korea Won |
| KWD | Kuwait Dinars |
| LBP | Lebanon Pounds |
| LKR | Sri Lanka Rupees |
| MAD | Morocco Dirhams |
| MTL | Malta Liri |
| MUR | Mauritius Rupees |
| MXN | Mexico Pesos |
| MYR | Malaysia Ringgits |
| NGN | Nigeria Nairas |
| NOK | Norway Kroner |
| NZD | New Zealand Dollars |
| OMR | Oman Rials |
| PEN | Peru Nuevos Soles |
| PHP | Philippines Pesos |
| PKR | Pakistan Rupees |
| PLN | Poland Zlotych |
| QAR | Qatar Riyals |
| ROL | Romania Lei |
| RON | Romania New Lei |
| RUB | Russia Rubles |
| RUR | Russia Rubles |
| SAR | Saudi Arabia Riyals |
| SDD | Sudan Dinars |
| SEK | Sweden Kronor |
| SGD | Singapore Dollars |
| SIT | Slovenia Tolars |
| SKK | Slovakia Koruny |
| THB | Thailand Baht |
| TND | Tunisia Dinars |
| TRL | Turkey Liras |
| TRY | Turkey New Lira |
| TTD | Trinidad and Tobago Dollars |
| TWD | Taiwan New Dollars |
| USD | United States Dollars |
| VEB | Venezuela Bolivares |
| VND | Vietnam Dong |
| XAF | CFA Francs BEAC |
| XAG | Silver Ounces |
| XAU | Gold Ounces |
| XCD | East Caribbean Dollars |
| XDR | IMF Special Drawing Rights |
| XOF | CFA Francs BCEAO |
| XPD | Palladium Ounces |
| XPF | CFP Francs |
| XPT | Platinum Ounces |
| ZAR | South Africa Rand |
| ZMK | Zambia Kwacha |


Länder:

| AFG | Afghanistan |
| ET | ?gypten |
| AX | ?land |
| AL | Albanien |
| DZ | Algerien |
| UM | Amerikanisch-Ozeanien (US Minor Outlying Islands) |
| AS | Amerikanisch-Samoa |
| VI | Amerikanische Jungferninseln |
| AND | Andorra |
| AO | Angola |
| AI | Anguilla |
| AQ | Antarktis |
| AG | Antigua und Barbuda |
| GQ | ?quatorialguinea |
| RA | Argentinien |
| ARM | Armenien |
| AW | Aruba |
| AZ | Aserbaidschan |
| ETH | ?thiopien |
| AUS | Australien |
| BS | Bahamas |
| BRN | Bahrain |
| BD | Bangladesch |
| BDS | Barbados |
| BY | Belarus (Wei?russland) |
| B | Belgien |
| BH | Belize |
| DY | Benin |
| BM | Bermuda |
| BHT | Bhutan |
| BOL | Bolivien |
| BIH | Bosnien-Herzegowina |
| RB | Botsuana |
| BV | Bouvetinsel |
| BR | Brasilien |
| IO | Territorium im Indischen Ozean |
| BRU | Brunei Darussalam |
| BG | Bulgarien |
| BF | Burkina Faso |
| BU | Burundi |
| RCH | Chile |
| CN | China, Volksrepublik |
| CK | Cookinseln |
| CR | Costa Rica |
| CI | C?te d'Ivoire (Elfenbeink?ste) |
| DK | D?nemark |
| D | Deutschland |
| WD | Dominica |
| DOM | Dominikanische Republik |
| DJI | Dschibuti |
| EC | Ecuador |
| ES | El Salvador |
| ER | Eritrea |
| EST | Estland |
| FK | (Malwinen) |
| F? | F?r?er |
| FJI | Fidschi |
| FIN | Finnland |
| F | Frankreich |
| FX | Frankreich, Metropolitan |
| GF | Franz?sisch-Guyana |
| PF | Franz?sisch-Polynesien |
| TF | Franz?sische S?d- und Antarktisgebiete |
| GA | Gabun |
| GM | Gambia |
| GE | Georgien |
| GH | Ghana |
| GBZ | Gibraltar |
| WG | Grenada |
| GR | Griechenland |
| GR? | Gr?nland |
| GP | Guadeloupe |
| GU | Guam |
| GCA | Guatemala |
| GBG | Guernsey |
| RG | Guinea |
| GW | Guinea-Bissau |
| GUY | Guyana |
| RH | Haiti |
| HM | Heard und McDonaldinseln |
| HN | Honduras |
| HK | Hongkong |
| IN | Indien |
| RI | Indonesien |
| GBM | Insel Man |
| IRQ | Irak |
| IR | Iran, Islamische Republik |
| IRL | Irland |
| IS | Island |
| IL | Israel |
| I | Italien |
| JA | Jamaika |
| J | Japan |
| YE | Jemen |
| GBJ | Jersey |
| JOR | Jordanien |
| KY | Kaimaninseln |
| K | Kambodscha |
| CAM | Kamerun |
| CDN | Kanada |
| IC | Kanarische Inseln |
| CV | Kap Verde |
| KZ | Kasachstan |
| Q | Katar |
| EAK | Kenia |
| KS | Kirgisistan |
| KI | Kiribati |
| CC | (Keelinginseln) |
| CO | Kolumbien |
| COM | Komoren |
| CD | Kongo, Demokratische Republik (ehem. Zaire) |
| CG | Kongo, Republik |
| KP | Korea, Demokratische Volksrepublik (Nordkorea) |
| ROK | Korea, Republik (S?dkorea) |
| HR | Kroatien (Hrvatska) |
| C | Kuba |
| KWT | Kuwait |
| LAO | Laos, Demokratische Volksrepublik |
| LS | Lesotho |
| LV | Lettland |
| RL | Libanon |
| LR | Liberia |
| LY | Libysch-Arabische Dschamahirija (Libyen) |
| FL | Liechtenstein |
| LT | Litauen |
| L | Luxemburg |
| MO | Macao |
| RM | Madagaskar |
| MW | Malawi |
| MAL | Malaysia |
| MV | Malediven |
| RMM | Mali |
| M | Malta |
| MA | Marokko |
| MH | Marshallinseln |
| MQ | Martinique |
| RIM | Mauretanien |
| MS | Mauritius |
| YT | Mayotte |
| MK | Mazedonien |
| MEX | Mexiko |
| FSM | Mikronesien |
| MD | Moldawien |
| MC | Monaco |
| MGL | Mongolei |
| MS | Montserrat |
| MOC | Mosambik |
| MYA | Myanmar (Burma) |
| NAM | Namibia |
| NR | Nauru |
| NP | Nepal |
| NC | Neukaledonien |
| NZ | Neuseeland |
| NIC | Nicaragua |
| NL | Niederlande |
| NA | Niederl?ndische Antillen |
| RN | Niger |
| WAN | Nigeria |
| NU | Niue |
| MP | Marianen |
| NF | Norfolkinsel |
| N | Norwegen |
| OM | Oman |
| A | ?sterreich |
| PK | Pakistan |
| PS | Autonomiegebiete |
| PW | Palau |
| PA | Panama |
| PG | Papua-Neuguinea |
| PY | Paraguay |
| PE | Peru |
| RP | Philippinen |
| PN | Pitcairninsel |
| PL | Polen |
| P | Portugal |
| PR | Puerto Rico |
| RE | R?union |
| RWA | Ruanda |
| RO | Rum?nien |
| RUS | Russland |
| SB | Salomonen |
| Z | Sambia |
| WS | Samoa |
| RSM | San Marino |
| ST | S?o Tom? und Pr?ncipe |
| KSA | Saudi-Arabien |
| S | Schweden |
| CH | Schweiz |
| SN | Senegal |
| SCG | Serbien und Montenegro |
| SY | Seychellen |
| WAL | Sierra Leone |
| ZW | Simbabwe |
| SGP | Singapur |
| SK | Slowakei |
| SLO | Slowenien |
| SP | Somalia |
| E | Spanien |
| LK | Sri Lanka |
| SH | St. Helena |
| KN | St. Kitts und Nevis |
| WL | St. Lucia |
| PM | Pierre und Miquelon |
| WV | St. Vincent und die Grenadinen |
| ZA | S?dafrika |
| SD | Sudan |
| GS | S?dgeorgien & Sandwichinseln |
| SUR | Suriname |
| SJ | und Jan Mayen |
| SD | Swasiland |
| SYR | Syrien, Arabische Republik |
| TJ | Tadschikistan |
| RC | Taiwan, Republik China |
| EAT | Tansania |
| THA | Thailand |
| TL | Timor-Leste |
| RT | Togo |
| TK | Tokelau |
| TO | Tonga |
| TT | Trinidad und Tobago |
| TD | Tschad |
| CZ | Tschechische Republik |
| TN | Tunesien |
| TR | T?rkei |
| TM | Turkmenistan |
| TC | und Caicosinseln |
| TV | Tuvalu |
| EAU | Uganda |
| UA | Ukraine |
| H | Ungarn |
| ROU | Uruguay |
| UZ | Usbekistan |
| VU | Vanuatu |
| V | Vatikan (Heiliger Stuhl) |
| YV | Venezuela |
| UAE | Vereinigte Arabische Emirate |
| USA | Vereinigte Staaten von Amerika |
| GB | Gro?britannien |
| VN | Vietnam |
| WF | Wallis und Futuna |
| CX | Weihnachtsinsel |
| EH | Westsahara |
| RCA | Zentralafrikanische Republik |
| CY | Zypern |
| HR | Kroatien |
| SRB | Republik Serbien |
| ME | Montenegro |


Belegarten:

'AN' => 'Angebot',
'AB' => 'Auftragsbestätigung',
'RE' => 'Rechnung',
'RB' => 'Barrechnung',
'AR'=>'Abschlagsrechnung',
'GU' => 'Gutschrift',
'LI' => 'Lieferschein',
'MA' => 'Mahnung',
'BE' => 'Lieferantenbestellung',
'SR' => 'Serienrechnung',
'LR' => 'Lieferantenrechnung'
'RT' => 'Retoure'

Zahlverfahren:

'E' => 'Einzug',
'L' => 'Lastschrift',
'U' => 'Rechnung (Überweisung)',
'NN' => 'Nachnahme',
'KK' => 'Kreditkarte',
'VK' => 'Vorauskasse',
'B' => 'Barverkauf',
'PP' => 'PayPal',
'CB' => 'ClickandBuy',
'MB' => 'moneybookers',
'MP' => 'mpass',
'ID' => 'iDEAL',
'SU' => 'Sofortüberweisung',
'AZ' => 'Amazon Payment',
'GP' => 'GiroPay',
'UT' => 'United Transfer',
'EC' => 'EC-Karte',
'FZ' => 'Finanzierung',

Artikel-Einheiten:

'Stück' => 'Stück',
'm' => 'm',
'm2' => 'm²',
'm3' => 'm³',
=> '-- Keine --'