API:POST /submission

From SoFurry
Revision as of 13:27, 25 April 2016 by Tetsudra (talk | contribs)
Jump to: navigation, search

This is the first step in uploading new content into SoFurry. First, a Submission record is created via this method. It is then populated using the PUT method.

Note that this API endpoint is still under development. Among the upcoming changes:

  • Subtypes - be more specific about the type of image, for eg: image.jpg, story.pdf, music.mp3
  • Content URLs - the return object will have a URL to access the content directly
  • Resolved User - Instead of just an ID, return the full user profile object in the same call, under user

Resource URL

https://api.sofurrybeta.com/submission

Request

POST /submission
X-SoFurry-Token: 1:3e9ed5866113d0a5b95b4798f8e7db9a
{
  "title": "My awesome artwork", # Required, String
  "type": "image", # Required, One of: image, music, story, flash
  "rating": "clean" # Required, One of: clean, adult, extreme
  "description": "Some sample artwork", # Required, Max 8192 characters
  "visible": true
}

Response: Success

HTTP 200
{
  "user_id": 1,
  "title": "My awesome artwork",
  "type": "image",
  "description": "Some sample artwork",
  "visible": true,
  "rating": "clean",
  "guid": "f8a89ef6-34ac-a7a5-0c00-ad22165c46ba",
  "updated_at": "2016-04-25 13:23:41",
  "created_at": "2016-04-25 13:23:41",
  "id": 5
}

The result will be the submission object itself. Once the submission is created it needs to be populated with the PUT method.