Kompoz Developer Center
REST stands for Representational State Transfer. Most of the Komopoz Web Services use "REST-Like" RPC-style operations over HTTP GET or POST requests with parameters URL encoded into the request. Kompoz Web Services are for developers, businesses and researchers interested in using the Kompoz platform to create new and useful application for Kompoz members.
REST services offer several advantages, such as:
REST URL Construction
Most API requests will use GET, but data can also be submitted using a POST. All service URLs start with the host name, such as:
After the host name, include the context and the service version number, such as:
Next is the service name. The service name should end with ".rest"" (for XML output), or ".json" (for JSON output). For exampe:
getProjects.rest or getProjects.json
Those components form the base URL, and would be assembled as:
The service name is followed by the actual query parameters, which take the form argument=value, where the arguments and values are url encoded. Multiple parameters are separated by an ampersand (&). Refer to the documentation for each service to see a list of valid arguments.
If a client chooses to use the POST method, the POST URL would include everything up to the question mark (but not including the question mark). Parameters would be passed as normal HTTP name-value pairs.
The Kompoz API methods require authentication. For the time being, HTTP Basic Authentication is the only supported authentication scheme. When authenticating via Basic Auth, use your registered Kompoz username as the username component, and your Kompoz password as the password component. Some service operations require an additional client ID (see each operation for details).
Kompoz Services RegistryMember Services
Looking for additional Web services? Contact us with details about what you need. Chances are, we'll build it for you.
Copyright © 2007 - 2013, Kompoz, LLC