Version 2.x should be considered as the coming stable release branch, but there are still no officla release.
Endpoints is automatically detected (for the upcoming API viewer) and can be found here.
In version 2.x you may see the responses in a few different responses. They are called with the parameter viewport (either use ?viewport=X, &viewport=X or as a post parameter). All viewports displays output data in UTF-8 encoding.
If you trust our responses and want to save bandwidth, you may also want to use viewmode=tiny, to only show "relevant" data. However, errors and other data are suppressed in this mode.
|pretty||JSON (Encoded with |
If driver is available, this viewport will be based on XML_Serializer. If our XML_Serializer fails, we will fall back to the SimpleXMLElement class.
|phpserialize||A php serialized string|
|A string based on print_r()|
Compression and encoding
There are undocumented and untested support for compression, that can be called by using encode=<encodeType>. The output format will be a double encoded result string that looks like this, and are named as their methods:
The response itself is the real rendered response. The supported encoding are listed below.
|Compression type||Method||Level||Response key||Other info|
|md5||md5||-||md5EncodedResponse||This is actually only a testing function and won't compress anything|
|API v1.x (Deprecated)||Docs for version 1.x|
|API v2.0||Docs for version 2.x|
Versions, changes, etc
|Version||Changes, removals, adds, etc|
|1.0.5||Deprecation when 2.x are officially released|
|2.0.0||Initialized project. Still in alpha mode.|