The Webshopapp REST API

Published at 13-04-2012 00:54, last updated at 06-07-2012 14:40

The WebshopApp API makes it easy to integrate your applications with WebshopApp. Important store data such as orders, products, customers, categories, shipments and brands can be retrieved and modified as required. Our standards-compliant RESTful API both accepts and responds with XML or JSON-formatted data.

RESTful

The WebshopApp API is implemented as JSON or XML over HTTP using all four verbs (GET/POST/PUT/DELETE). Every resource, like product, category, customer or order, has their own URL and are manipulated in isolation.

In other words, we’ve tried to make the API follow the REST principles as much as possible. For more information on REST please see: What is a REST?.


Authentication

To use the WebshopApp API you will need an API key for your store.

Please ask our support team if you want to develop a new API-based application. For now we will need your details:

  • Your applications name
  • A short description
  • If you need only read or also write access

Authentication is managed via HTTP authentication. Every request must include the Authorization HTTP Header.

Every WebshopApp API-Call will look like this:

https://api_key:api_token@api.webshopapp.com/en/resources.json

 

Resources

Each resource has to be manipulated in isolation. Instead of including associated resources, each resource object has a counter on the associated resource.

E.g a order resource will have a products-resource instead of messing up the data stream by including all products at once.

Some resources are provided in a nested structure, but most of them can be manipulated also directly. For more information on the Webshopapp API resources please see: Resources.