!

You may now create eBooks of your strings! Click here, you lucky thing.
Keep going! Once you answer strings, you'll be able to create a printable eBook of your diary (find out more)
It looks like you're using a teeny-tiny web browser. Perhaps you'd like to use our mobile site?

The stringsof.me API

stringsof.me exposes a subset of functionality to third-party developers, allowing them to develop applications which read and write to the stringsof.me database.

Getting Started

Access to the API is done entirely over HTTP using GET requests. To facilitate cross-domain calls, responses are returned in JSONP format. With this in mind, accessing the stringsof.me API is as simple as formatting a URL, for example:

http://api.stringsof.me/Question/FollowPerson
	?PersonID=98
	&IsFollowing=true
	&_JsonPCb=OnGetPerson
	&_JsonPContext=red
	&_JsonUserID=492db77d-c22c-44b2-81af-6a902aa0aae4
	&_APIKey=myapikey

Each of these components is described in further detail below:

Component Example
Base API URL http://api.stringsof.me/
Function Name Question/FollowPerson
Parameter Indicator As with a regular URL, if you are submitting parameters, then you must append a question mark (?) to your URL
Function Parameters In the format of key/value pairs, such as personID=59. Multiple parameters are separated with an ampersand (&), for example personID=59&isFollowing=true.
User ID Many of the API requests are restricted by the currently logged in user. For example, a function GetAnswerForPerson() does not have a personID parameter, but instead assumes the person by whoever is currently logged in to your application. This is done by examining the _JsonUserID parameter in your GET request. For example, _JsonUserID=98098-90888-87855-89auya. The UserID is returned from the SubmitLogin API method.
API Key Each application is provided with a unique API key to authenticate your use of the API. This key must be passed in every request, just like a regular parameter in the form of _apikey=[yourapikey]. If you have not already done so, you may request an API key here.
JSONP Callback The name of the javascript function to wrap your JSON result in. For example, _JsonPCb=OnGetPerson. This will result in our API returning the following script:
OnGetPerson({FirstName : Larry, LastName : Phillips });
			
All you need to do is create the function in your own script as follows:
function OnGetPerson(person){
	alert(person.FirstName);
}

			
Additional Callback Parameters (optional) Because HTTP and JSONP requests are stateless, your callback may require additional information to serve as 'context' when data is returned from the stringsof.me server. For example, if you set _jsonpcontext='red' in your URL, you could then update your callback as follows:
function OnGetPerson(person, favouriteColor){
	alert(favouriteColor); // shows 'red'
}
You may include as many parameters as you like - just separate them with a comma. For example _jsonpcontext='red','dog' would serve the following callback:
function OnGetPerson(person, favouriteColor, favouriteAnimal){
	// etc etc
}
Have you been here before?
Username (will be shown on site)
Password (um, I forgot my password)

Now this is happening...