Introduction
Qizx Server API is a connector for Qizx Server
that exposes a simplified API.
With this connector, a Qizx XML
database becomes a back-end data server, that can be accessed by a variety
of clients:
Any application framework that supports HTTP client requests like
PHP, JSP, ASP* etc.
Heavy clients written in Java, .NET, C++ etc.
An example is
QizxStudio that can connect to a Qizx REST Server and be used as an
administration tool.
What the present pages are:
- A documentation describing requests accepted by the
server.
- An example that allows running the requests on a database
that you have created, and seeing the results.
What these pages are not:
- A server administration interface.
- A web application with a state-of-art user interface that could be
used for browsing and querying a Qizx XML database.
Qizx Studio can use this API, and provides a better user
interface.
Description of API requests:
Each request is
documented by a page describing it and allowing to test it with user
provided values:
- Purpose of the request
- Format of results
- Possible errors. The format of errors is described in a dedicated page.
- Arguments: each argument has a form field that is used to enter a
value.
- A Submit button can be used to run the request with the provided
arguments and see the results.