/cl-xplan-api

Mirror of https://gitlab.com/kierangrant/cl-xplan-api

Primary LanguageCommon LispOtherNOASSERTION

CL-XPLAN-API is a LISP library that makes it easier to interact with IRESS XPLAN API.

Whilst this software is released under the LLGPL, to actually connect to an IRESS XPLAN API Server requires you to have an API Key from them.

You need a use agreement with IRESS, though, nothing stops you using this library with a server that duplicates their API.

cl-json is currently patched by cl-xplan-api to include some new functionality needed by this library.

Documentation for XPLAN API is available (after registration) at:

Has been tested on SBCL and CLISP on GNU/Linux and Windows. Note: On Windows, you need to set the path to a CA file or directory. This setting is stored in the drakma-settings on the xplan-session. EG:

(setf
 (getf (cl-xplan-api/core:drakma-settings *sess*) :ca-file)
 "/Path/to/cacert.perm")

Please note, new entry-points are added all the time in newer XPlan Versions. There is no way to keep track of this other then continually reading release notes, even worse, according to IRESS, we cannot version test for an entry-point. We must just accept a HTTP 404 as probably meaning it isn't implemented on that version.