The SOAP V1 API represents an extension of the primary interface with read and write access. With it, data can be queried and changed object specifically. The scope of functions is based on the functions of the system, so that remote control of the system is possible to a limited extent.
Global users that are intended to use the SOAP API or are already used for this purpose should not be used to work in the system interface.
If this is still the case, you run the risk of making the global user a client user by switching to a client via the system interface, until this user switches back to the "Global Overview" via the system interface.
This can affect all methods that require the parameter mandator_id. In this case, this global user who has switched to a client would ignore the parameter mandator_id and use the ID of the client to which he or she has switched instead.
Use of the API
The authentication is done via Basic Auth. The necessary steps are usually taken over by the libraries used.
The user used to access the API requires the system right Webservices 2.0. You can find out how to configure roles and rights in our article"Configuring roles and rights
The SOAP protocol is language independent, server and clients can be implemented in any language such as Java, Perl, Python, PHP or Ruby. For SOAP, libraries are an integral part of many programming languages.
Details on libraries can be found at https://de.wikipedia.org/wiki/SOAP#Implementierungen .
Access to objects or resources
The following object types can be processed via the interface:
Please note that individually the request via the API must not exceed 10MB. This is a security policy. Larger requests have to be transmitted splitted.
EvalancheHashMaps are used everywhere where lists of key-value pairs are needed, but the keys are only determinable at runtime.
Since the property of the individual EvalancheHashMapItem must be of type string, the following rules apply to deviating data types:
See the following table for information on access points and WSDL files: