Everything You Ever Wanted to Know About the vWork API

Does vWork have any way of talking to my CRM/Job System/Billing System?

Yes, vWork has a fully documented RESTful API. Details below.

This article includes

What does REST mean?

REST is the type of API we offer. It is extremely common with modern web services and is very similar to HTTP (the way that web pages are sent back and forth on the Internet).

What does your API allow me to do?

The vWork API gives you full control over the data stored in your account (Jobs, Customers, Users, etc…) It allows you to easily create, modify and delete this data from another system like a CRM. It does not allow you to edit your account settings.

Can you connect vWork with my CRM/Job System/Billing System for me?

No, we are not programmers for hire, but we provide the tools for you to do it yourself. If you do not have this capability in house, you may need to hire a contractor to build what you need.

What kind of programmer do I need to hire?

The vWork API is extremely easy to use, is fully documented, and we are available to assist your programmer with any vWork problems they run into. It is more important that you hire a programmer who is familiar with the system you want to connect vWork to, as we will be unable to assist with this. Ideally they will have some experience with RESTful web services.

How do I find my API Key?

Once you have signed up for a free trial account, please email support@vworkapp.com and we can provide your key to you.

Can I change my API Key?

No, this is set at our end. If you need to change it please email us at: support@vworkapp.com.

Do you have any documentation for your API?

Yes, we have full documentation available at http://api.vworkapp.com/docs/getting_started as well as a list of Frequently Asked Questions here: https://vworkapp.zendesk.com/hc/en-us/sections/200678950-API-FAQ

Does your API work with my existing .NET SOAP service layer?

No, it is a RESTful API, you will need to write a piece of middleware to get these two systems talking to each other.

I don’t like XML, can I use JSON instead?

Not at this time. While we have limited support for JSON we do not supply this to customers for live integrations as it is in Beta phase and may change unexpectedly.

How secure is your API?

The API is secured using HTTPS (TLS 1.0 and up, support 128 and 256 bit AES), but you must keep your API key secure at all times. Any third party with your API key can manipulate your data.

My system has it’s own IDs for my records. Can I use them to keep track of my stuff?

Yes, we supply ID by default, but you can supply your own ID for Jobs, Customers and Users.

What happens if I build a connecter to vWork and you make changes in the future – could it stop working?

We work extremely hard to make sure that never happens. We only make changes to the API when absolutely necessary and these are usually additions of extra functionality rather than any breaking changes. Any modifications that may effect you will be communicated well in advance of any changes.

Major changes to the API are only made infrequently and these are issued with a new API version number.

While we may deprecate older API versions in the future, this has not occurred to date.

I can’t get any response from your API except for a 401 header, what does that mean?

A 401 response means that your request was unauthorized. You need to verify that the URL you are requesting has the API key appended to the query string like so: https://api.vworkapp.com/2.0/jobs.xml?api_key=xxx. If you have used the wrong API key you will also see a 401 response.

I have tried to update (job,customer etc) but all I can see is a 404 header, what does that mean?

It means that the resource you are trying to update does not exist. The record is most likely deleted or you have mistyped the ID. You should check the ID in the URL to make sure it is valid. You can use a GET request to index all available, non-deleted resources and check that the record exists if you feel there is an error.

Need more information? ask us hereHave more questions? Submit a request