Customers
User information
 Loading ...
Show article in Knowledge Base

 Introduction to the Web Service API Export knowledge base Export     SubscribeSubscribe      Show article info

VisionProject web service

Web Services are standards-based software components that can be accessed over the Internet.

 

VisionProject offers an interface based on SOAP. For more details of the API go to:

http://[YOUR VisionProject URL]/api/docs/index.html

 

There you have a complete documentation as well as code samples for Java and .NET. You can also see here:

http://www.visionproject.se/api/docs/index.html

 

If you want to use our API please contact our support at support@visionflow.com to get an API key.

 

SOAP

SOAP is the XML-based protocol for sending requests and responses to and from Web Services. VisionProject currently
supports SOAP, not XML-RPC or REST, i.e. you need to send document style requests. Please refer to your SOAP
Library/component documentation for information regarding SOAP communication.

If you are new to SOAP, you may also want to check out the introduction to SOAP from W3Schools found at
https://www.w3schools.com/xml/xml_soap.asp

 

Security

All information will be transferred directly between your web service client and VisionProject without any user interaction.
The actual communication is encrypted on the transport level with SSL.

 

Access to sensitive data is restricted by using user credentials in the same way as regular users in VisionProject. The
web service client accessing VisionProject will need to use an actual user account (Username and Password) associated
with it which is specified when logging in, see the login and logout web service methods.

 

If you are using the installed server version you can use the web service API out of the box. However, to be allowed to

access the web service API in the hosted version you will need a "web service API key", to get this you will need to

contact us via support@visionproject.se

 

Mount point

The mount point that you should use for the Web service API are for example like this:

 

"https://www.visionproject.se/service/VisionProject-v2/VisionProjectWebServiceService"

 

Java and .Net

The web service API has been tested using Java and .Net (C#), but should work using other technologies as well such
as php or Ruby. However, our examples are implemented using Java and C#.

 

Cookies

Cookies must be enabled for the Web Service API to work! Also, you need to re-use the sessions per web service call, otherwise you will put an unnecessary high load on our server 

 

Sample code for Java

 

visionProjectWebService._getBindingProvider().getRequestContext().put(BindingProvider.SESSION_MAINTAIN_PROPERTY,true);

 

 

Sample code for C#

 

this.CookieContainer = new System.Net.CookieContainer();

 

Restrictions, limitations and guidelines

The restrictions and limitations below must be followed if you want to use the web service API. If you don't follow the guidelines below, and don't make the necessary adjustments, we may decide to block your API calls at any time we see fit. 

 

Version number

 

Always try to use the latest version number for the web service API, this is currently 13.0

 

So the login call would look like this: loginWithAPIKey2("username", "password", "WSAPIKey", "13.0");

 

Number of requests

 

For the hosted version we have a limitation of the number of requests that can be made from one company free of charge when using the Web Service API. Currently that is 1200 requests per hour and if you exceed that number you will get an error and you will not be able to do any new requests until the next hour. There is also a burst rate of 4 calls per second to our server, but this normally regulated by the time it takes to execute a call. If you need to make more calls to our server than this, then please contact us and we will send you a price quote for additional usage.  

 

It is therefore recommended that you try to limit the number of calls to our server in your code. 

 

Session re-use

 

You must re-use the sessions between web service API calls, otherwise you will create too many sessions on our server. Please see the section "Cookies" above. 

 

No unnecessary logins

 

You should not log into the system on each web service API call. You shall re-use the a session between calls (see above), and as long as you have a valid session there is no need to log in to VisionProject again

 

Example of correct usage (using pseudo code):

 

  • Connect to the VisionProject
  • Receive a valid session that will be re-used between calls
  • Login
  • Call service 1
  • Call service 2
  • Call service 3
  • ...
  • ...
  • Call service X
  • Finally Logout

 

Do not:

 

  • Connect to the VisionProject
  • Receive a valid session that will be re-used between calls
  • Login
  • Call service 1
  • Logout
  • Login
  • Call service 2
  • Logout
  • Login
  • Call service 3
  • Logout

 

 

 

 

 


User comments
 Loading ...