What is an API
The integration between multiple information systems is essential. Without it a lot of manual re-keying of data are time consuming and scattered information. That is why we must allow application to communicate directly with each other in an automated fashion. This article describes how you can make your application capable of communicating with WEHOOP. In particular, you will learn how to retrieve data and create forms in WEHOOP automated manner or if you prefer, by programming. The technology used to integrate information systems is called API or Application Programming Interface.
What can you do with the API?
- It is possible using the API to retrieve data contained in WEHOOP. A wide range of useful information can be extracted and reused by your application. Among them we can mention the details of users, forms, history, approvals, access, etc…
- You can also create forms. But why not create forms directly in your application? WEHOOP forms are more than just forms. They deploy quickly, come with a process, a modern user interface, support for all major browsers and mobile devices, a history and access control. For this reason, it is advantageous to leave WEHOOP care of your forms. Creating new forms through the API you can also specify initial values for fields and who will complete them.
- There is also an advanced mode to do all the actions available from the interface WEHOOP. Such as: transfer, share, cancel, etc. .. (The documentation of these actions is not available for the moment).
How it works?
The API authenticates at first by an HTTP POST sent to the server WEHOOP with three (3) parameters: URL, Username and Password. The HTTPS protocol MUST be used for the connection.
When the Username and Password are validated, a cookie LtpaToken is returned and retained by the API. Each subsequent requests will automatically be accompanied by the cookie.
These requests are calls using the HTTPS protocol. The data are sent as POST containing a serialized object into JSON. (see json.org) This API is RESTful.
Using the API
The API is now available for both programming languages and others can be added on demand. These languages are .NET and Java. The API methods are documented, simply include these into your projects with Eclipse, Visual Studio, etc. .. Methods are the same regardless of the language used.
HOW?
- Instantiate an Hoop object type.
- Call the “connect” method on the instance.
- Call method “search” or “create”.
Some examples
Here is an example to start a process whose ID is “C826B0EBD46FBA16852579B50071DB4E”.
Java Language
Hoop hoop = new Hoop();
hoop.connect("https://hoop.kiwi.ca", "*****", "*********");
JSONObject hoopForm = hoop.create("C826B0EBD46FBA16852579B50071DB4A");
System.out.println(hoopForm.toString()); // Print all the values of the form in JSON format to the console.
C# Language
Hoop hoop = new Hoop();
hoop.connect("https://hoop.kiwi.ca", "*****", "*********");
JObject hoopForm = hoop.create("C826B0EBD46FBA16852579B50071DB4A");
Console.Write(hoopForm.ToString()); // Print all the values of the form in JSON format to the console.
Contact Us
To get the latest version of the WEHOOP API, contact us at 1-855-274-1118 and ask to speak with our support team.