Getting Started

This section of the website is for application developers. The Vendexo system provides a service Application Program Interface (API) enabling applications to have access to certain resources on the system. It supports the transfer of data in JSON or XML formats, and follows the RESTful style for accessing resources.

Resources

In the REST style, each resource is identified by a unique URI, and so it is possible, for example, to access a particular order for an online shop via the URI which identifies that order. Some resources refer to lists of items, like the orders of a shop, and various filters can be applied depending on the resource. For example one can get a list of orders created after a certain date. To protect information privacy, the resource owner (the merchant responsible for the shop, in this example) needs to be able to control which applications have access to their information. They do this via an authentication and authorization process which grants various permissions for one or more sets of resources to the application. For more on authentication and authorization see Authorizing Access.

For more information about the particular resources accessible via the API see Resources