Difference between revisions of "QM Client API"
(Updated PDF link to new one) |
(Added doc update) |
||
| Line 19: | Line 19: | ||
'''Resolved''' - Turns out it was the new server environment. However the Documentation is slightly wrong for the login protocol. Login is actually a server command not a special case. Will try and update the docs and debug the further issues on the test server environment. | '''Resolved''' - Turns out it was the new server environment. However the Documentation is slightly wrong for the login protocol. Login is actually a server command not a special case. Will try and update the docs and debug the further issues on the test server environment. | ||
| + | |||
| + | '''Update''' - The packet header docs have been updated, and the whole login process is pretty clean. The docs are missing a large number of the simpler commands, but they are pretty easy to figure out from the VBSRVR basic code in GPL.BP. I will write them out progressivly. | ||
==API library's== | ==API library's== | ||
Revision as of 20:22, 12 January 2009
Overview
QM provides a remote API access to any client system that can get to the server via socket 4243, and obeys the protocol.
Server Setup
QM is technically able to handle API connections about of the box. However your server will need some configuring. (RPM will do this for you in near future).
Protocol
The following is a guide to the protocol that the server responds to.
Currently a working document, far from perfect, but you get the idea:
QMClient-Protocol.v0.3.alpha.pdf
Warning: I have suspicions that the protocol changed for login quite dramatically for 2-6-6, as opposed to 2-4-17 which this Spec doc was originally based on.
Confirmed - Functioning Java-QM client for 2.4.17 does not work on 2.6.6. Exact reason why has yet to be determined. Should have some answers soon, new year 2009 has a need for the Java API on 266.
Resolved - Turns out it was the new server environment. However the Documentation is slightly wrong for the login protocol. Login is actually a server command not a special case. Will try and update the docs and debug the further issues on the test server environment.
Update - The packet header docs have been updated, and the whole login process is pretty clean. The docs are missing a large number of the simpler commands, but they are pretty easy to figure out from the VBSRVR basic code in GPL.BP. I will write them out progressivly.
API library's
- C - native - Released
- Visual Basic - native - released (library only released with commercial?)
- Java API - native - Alpha stage
- Delphi - Wrapper - (native expected Q1 2009)
- PHP - wrapper - Beta (Native - Prototype (Dec 08))
