This page deals with the new-format REST API being developed as part of SoFurry NEXT. For documentation on the current "v3" API, please see SoFurry_REST_APIs.
About the API
The api runs on lumen, is classic json/rest, at the domain name api.sofurrybeta.com. It should always be accessed over HTTPS.
Making a simple API request
GET request sample
POST for login to create a session, get a token
This table contains all the methods and URLs that the API currently supports. For more information on using a particular route, simply go through to that route's page.
Some routes have no parameters at all, and can be accessed simply by doing the HTTP request. Some routes require parameters as part of the URL - they will be denoted by curly braces, and are always mandatory. Some requests expect parameters to be sent in the body of a JSON request.
Users and Profiles
These routes are all about managing user accounts and profiles. Not all the routes are secure (require authentication).
||Returns the version of the API||No||Live|
||email, password||Validates the supplied credentials and returns an authentication token that should be used for all future requests||No||Live|
||activate_token||Activates a newly-registered user, enabling you to log in||No||Live|
||name, email, password||Register a new user account and trigger a validation email to the supplied email address||No||Live|
||Returns a JSON object with the profile details of the authenticated user||Yes||Live|
||id=User ID||Returns the profile information for a different User ID.||Yes||Live|
||bio||Make an update to the profile of the authenticated user by overwriting several fields.||Yes||Live|
These routes are all about creating and managing individual submissions.
To do: Search submissions
||title, type, rating, description, visible||Create a new Submission record. It won't be shared until it has been populated with some content||Yes||Live|
||id=Submission ID||Retrieve a Submission JSON object.||Yes||Live|
||id=Submission ID, (binary stream)||Store a binary content stream against a submission. By default, populating a submission for the first time will publish it to your watchers, and the global gallery.||Yes||Live|
Methods for interacting on forums, still in development
A Gallery is a collection of artwork. By default, there is a global SoFurry Gallery into which all content is published.
As a user, a gallery is created for you as soon as you upload your first piece of content. Galleries can also be created to curate content, and are created to support RP Universes.
An RP Universe is built around a collection of roleplay posts, supplemented by artwork. These methods are for creating new universes, inviting characters to participate, the actual participation, and linking relevant content into the Universe.
The Character system allows users to create roleplaying characters, which can be used to interact across the site.
Methods for creating and updating journal entries
Methods for listing, reading and sending Private Messages
List and get connection info for chatrooms. The actual rooms will be joined using a different method.