Einleitung
Die SOAP V1 API stellt eine erweiterung der primären Schnittstelle mit Lese- und Schreibzugriff dar. Mit ihr können Daten objektspezifisch abgefragt und geändert werden. Der Funktionsumfang orientiert sich an den Funktionen des Systems, so dass in einem eingeschränkten Umfang eine Fernsteuerung des Systems möglich wird.
Bitte beachten!
Globale Benutzer, welche zur Nutzung der SOAP-API vorgesehen sind oder bereits dafür verwendet werden, sollten nicht zum arbeiten in der Systemoberfläche verwendet werden.
Wenn dies dennoch der Fall ist, laufen Sie Gefahr durch einen Wechsel in einen Mandanten über die Systemoberfläche den globalen Benutzer zu einem Mandanten-Benutzer zu machen, und zwar solange, bis dieser Benutzer über die Systemoberfläche wieder auf die “Globale Übersicht” wechselt.
Dies kann Auswirkungen auf alle Methoden haben, welche den Parameter mandator_id benötigen. Hier würde dieser globale Benutzer welcher in einen Mandanten gewechselt hat, den Parameter mandator_id ignorieren und stattdessen die ID des Mandanten verwenden, in den er gewechselt wurde.
Verwendung der API
Authentifizierung
Die Authentifizierung erfolgt über Basic Auth. Die erforderlichen Schritte werden in der Regel von den verwendeten Bibliotheken übernommen.
Der für den Zugriff auf die API verwendete Benutzer benötigt das System Recht Webservices 2.0. Wie Sie Rollen und Rechte konfigurieren, erfahren Sie in unserem Beitrag "Rollen und Rechte konfigurieren".
Unterstützte Protokolle
Das SOAP Protokoll ist sprachunabhängig, Server und Clients können in beliebigen Sprachen wie Java, Perl, Python, PHP oder Ruby implementiert werden. Für SOAP sind Bibliotheken integraler Bestandteil vieler Programmiersprachen.
Details zu Bibliotheken finden sich unter https://de.wikipedia.org/wiki/SOAP#Implementierungen
Zugriff auf Objekte bzw. Ressourcen
Folgende Objekttypen können über die Schnittstelle verarbeitet werden:
- Accounting
- Blacklist
Einschränkungen
Bitte beachten Sie, dass einzeln der Request über die API nicht mehr als 10MB groß sein darf. Dies ist eine Sicherheitsrichtlinie. Größere Requests müssen geteilt übertragen werden.
Allgemeine Verwendung
EvalancheHashMaps werden überall dort eingesetzt, wo Listen von Key-Value-Paaren benötigt werden, die Keys im jedoch erst zur Laufzeit bestimmbar sind.
Da die Eigenschaft des einzelnen EvalancheHashMapItem vom Typ string sein muss, gelten folgende Regeln bei abweichenden Datentypen:
WSDL
Informationen zu Zugriffspunkten und WSDL Dateien finden Sie in der folgenden Tabelle:
| Port | WSDL Document/literal |
|---|---|
| Accounting | [LOGIN_DOMAIN]/api/soap/v1/accounting/wsdl |
| Blacklist | [LOGIN_DOMAIN]/api/soap/v1/blacklist/wsdl |