RESTful API Documentation

Introduction

The API documented below is a RESTful API for use with this website.

Calling methodology

This API is focused on ease of integration with existing browsers and expects parameters to either be passed as regular HTTP query parameters in the case of GET based queries, and form encoding in the case of PUT and POST parameters. Responses to API calls are provided in JSON.

Each call documented below has some number of required or optional parameters, they are noted as such.

Client side JavaScript API

There is a generated client-side API for use in the browser available at <%=Hop.apiURL%>

Authentication

Authentication is managed via cookie based sessions upon authentication.

Notes

<%if(typeof _csrf!="undefined"){%>

Cross Site Request Forgery

This site utilizies CSRF protection and requires a special field called _csrf to be included in all POST and PUT queries. This is handled by default in the JavaScript API, but the field still must be defined in client side pages that use the JavaScript API.

<%}%>

<%= Hop.renderBeforeTemplates("Doc") %>

API

<% for(var objName in Hop.Objects){ var obj = Hop.Objects[objName]; %>

<%=obj.name%>

<%=(obj.desc?obj.desc:"")%>

<%= obj.renderBeforeTemplates("Doc", { object: obj }) %>

<% for(var methodName in obj.methods){ var method = obj.methods[methodName]; var params = Object.keys(method.params).map(function(paramName){ return method.params[paramName].demand?paramName+"*":paramName; }); %>

<%=obj.name%>.<%=method.name%>(<%=params.join(", ")%>)

<%= method.renderBeforeTemplates("Doc", { method: method}) %>

<% if(method.desc){ %> Overview

<%=(method.desc?method.desc:"")%>

<% } %> <% if(params.length>0){ %> Parameters <%for(var paramName in method.params){ var param = method.params[paramName]; %> <%}%>

<%=paramName%>

<%=(param.desc?param.desc:"")%>

<%if(param.demand){ %>Required<%}%>

<%}%>

Javascript

<%=obj.name%>.<%=method.name%>(input,onComplete)

HTTP

<%=method.method%> <%=method.fullPath%>

<%if(method.secore){%>secure<% } %>

<%= method.renderAfterTemplates("Doc", { method: method}) %>

<% } %>

<%= obj.renderAfterTemplates("Doc", { object: obj }) %>

<% } %>

<%= Hop.renderAfterTemplates("Doc") %>