dtRdr::doc::AnnotationServers 0.11.2

dtRdr::doc::AnnotationServers is a Perl module that contains remote annotation server details.
Initial Interaction
Discovery
- get server version/capabilities
- possibly login at this point
- maybe create-account API?
Sounds like delegation is in order.
$base = "http://example.com/annotation_server";
foreach $plugin (@plugins) {
$plugin->identify_uri($base) and last;
}
version.yml
For best results, a server should provide a capabilities url at "$base/version" which returns a yaml file describing the server type/version.
---
type: example_type
version: 0.5
This could be served by the framework, or just be a static file. The benefit is not having to return a series of 404s or other errors while the plugins poke at your server.
The path to version.yml is derived from the base URL as follows:
base: http://example.com/anno
look: http://example.com/anno/version.yml
Possibly also:
base: http://example.com/anno/index.php
look: http://example.com/anno/version.yml
base: http://example.com/anno/foo.php
look: http://example.com/anno/version.yml
base: http://example.com/?q=annoserve
look: http://example.com/?q=annoserve&dotreader_asks=version.yml
plugin-specific discovery
A specific noteserver plugin may then get additional initialization data. For the dtRdr::Annotation::Sync::Standard module, this path is:
http://example.com/annoserve/config.yml
Returns
---
or, if there are config options:
---
protocol: https
auth_required: 1
login:
url: http://example.com/login
template: edit[name]=#USERNAME#&edit[pass]=#PASSWORD#
Cookie-Based login
The auth_required directive instructs the client to login before attempting any read operations.
The login directive instructs the client to fill-in the template data and post it to the given url.