HTTP Form Interface

The HTTP Form interface is basically a simple HTTP GET or POST request to a URI on our system. This is very easy to code directly into your application, usually not even requiring any specifial library.

To access a function through the HTTP Form interface, basically you need to submit a request to the URI in the following format:

https://byrsvp.com/httpapi/<function>

<function> is the name of the function you want to access.

All the function parameters are specified as form parameters in the URI request. When you use th GET method, this means that the URI will have this format:

https://byrsvp.com/httpapi/<function>?<name1>=<value1>&<name2>=<value2>

<name1> and <name2> are the paramter names, and <value1> and <value1> are the corresponding values.

If you use the HTTP POST method, then the parmaters are encoded in the POST contents.

This is the example for calling the rsvpHelloWorld function with a specified message.

https://byrsvp.com/httpapi/rsvpHelloWorld?message=This+is+a+test

Remember that paramters in the URI needs to be properly URI encoded. (It is not just about converting spaces to the + character like in the above. There are other special characters that also need to be encoded.)