Following question by a DataMiner user has also crossed my mind before, making it a good opportunity to check on this platform.
The API documentation mentions 2 API interfaces – SOAP and JSON. The SOAP one makes sense but I am a little confused by the JSON one, and the fact the JSON one has a WSDL. Is the JSON API a SOAP API? My understanding was that SOAP protocol uses XML, and that WSDL’s are a SOAP thing. Could you explain the difference between the 2 interfaces? Should the JSON API have a JSON schema instead?
Our API interfaces are build on top of Microsoft ASMX WebServices, which is basically a SOAP interface with some support for JSON. Unfortunately, it does not offer a JSON schema. The WSDL of our JSON interface makes indeed no sense and shouldn't be used.
Regarding the difference, the SOAP interface will always return results as XML, while the result of the JSON interface will always return JSON data.
Additional hints when using the JSON interface:
1. The URL shall be the base path and the required method. For instance, to initially connect, the URL will be:
http://DmaNameOrIpAddress/API/v1/json.asmx/ConnectApp
2. The content-type must be application/json
3. The content will be the same as in the examples observing the case of the fields:
{
“host”: “thehost”,
“login”: “user”,
“password”: “passord”,
“clientAppName”: “Simple Test”,
“clientAppVersion”: “1.0”,
“clientComputerName”: “”
}